shinkansen-rails 1.0.269 → 1.0.271

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-rails",
-  "version": "1.0.269",
+  "version": "1.0.271",
   "description": "Shinkansen Rails",
   "keywords": [
     "Shinkansen",
@@ -38,23 +38,26 @@
     "debug": "^4.4.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.7",
-    "@babel/eslint-parser": "^7.26.5",
-    "@babel/preset-env": "^7.26.7",
+    "@babel/core": "^7.26.8",
+    "@babel/eslint-parser": "^7.26.8",
+    "@babel/preset-env": "^7.26.8",
     "@babel/register": "^7.25.9",
     "@sequencemedia/eslint-config-standard": "^0.2.18",
     "@sequencemedia/eslint-config-typescript": "^0.1.27",
+    "@types/babel__register": "^7.17.3",
+    "@types/debug": "^4.1.12",
     "@typescript-eslint/eslint-plugin": "^8.23.0",
     "@typescript-eslint/parser": "^8.23.0",
     "chai": "^5.1.2",
     "core-js": "^3.40.0",
     "cross-env": "^7.0.3",
-    "eslint": "^9.19.0",
+    "eslint": "^9.20.0",
     "eslint-import-resolver-babel-module": "^5.3.2",
     "globals": "^15.14.0",
     "husky": "^9.1.7",
     "mocha": "^11.1.0",
-    "sinon": "^19.0.2"
+    "sinon": "^19.0.2",
+    "typescript": "^5.7.3"
   },
   "imports": {
     "#rails": "./src/index.mjs",

package/src/index.cjs

@@ -11,7 +11,7 @@ const log = debug('shinkansen-rails')
 log('`shinkansen` is awake')
 
 const {
-  default: Rails
+  default: Rails // @ts-ignore
 } = require('./rails/index.mjs')
 
 module.exports.Rails = Rails

package/src/rails/index.d.mts

@@ -3,15 +3,15 @@ declare module '#rails/rails' {
   export function has (o: Record<PropertyKey, unknown>, k: string): boolean
   export function get (o: Record<PropertyKey, unknown>, k: string): unknown
 
-  export function rail (p: string): string
-  export function go (o: Record<PropertyKey, unknown>, p: string): boolean
-  export function to (o: Record<PropertyKey, unknown>, p: string): boolean
+  export function rail (p?: string): string
+  export function go (o?: Record<PropertyKey, unknown>, p?: string): boolean
+  export function to (o?: Record<PropertyKey, unknown>, p?: string): string
 
   export default class Rails { // eslint-disable-line @typescript-eslint/no-extraneous-class -- Static class
-    static pattern (p: string | undefined): string
-    static rail (p: string | undefined): string
-    static go (o: Record<PropertyKey, unknown> | undefined, p: string | undefined): boolean
-    static to (o: Record<PropertyKey, unknown> | undefined, p: string | undefined): boolean
+    static pattern (p?: string): string
+    static rail (p?: string): string
+    static go (o?: Record<PropertyKey, unknown>, p?: string): boolean
+    static to (o?: Record<PropertyKey, unknown>, p?: string): string
   }
 }
 

package/src/rails/index.mjs

@@ -4,6 +4,7 @@ const log = debug('shinkansen-rails')
 
 log('`shinkansen` is awake')
 
+// @ts-ignore
 let pattern
 
 const map = new Map()
@@ -21,12 +22,14 @@ export const any = (o) => !!Reflect.ownKeys(o).length
 /**
  *  @param {Record<PropertyKey, unknown>} o   The object containing values
  *  @param {string} k   The value name
+ *  @returns {boolean}
  */
 export const has = (o, k) => Reflect.has(o, k)
 
 /**
  *  @param {Record<PropertyKey, unknown>} o   The object containing values
  *  @param {string} k   The value name
+ *  @returns {unknown}
  */
 export const get = (o, k) => Reflect.get(o, k)
 
@@ -47,7 +50,6 @@ export function rail (p) {
  *
  *  @param {Record<PropertyKey, unknown>} o   The object containing values for the 'pattern'
  *  @param {string} p   The 'pattern' according to which URLs should be created
- *  @param {boolean} b  Whether the Rails can go
  *  @return {boolean}
  *
  *  @description
@@ -68,7 +70,7 @@ export function go (o, p) {
 
   if (b) {
     let k
-    const a = p.match(/(\w+)/g)
+    const a = p.match(/(\w+)/g) ?? []
     while (b && (k = a.shift())) b = has(o, k) // it is only necessary that the `o` has key `k`. Otherwise, `b = has(o, k) && !!get(o, k)` to enforce a truthy field value for field key `k`
   }
 
@@ -86,31 +88,35 @@ export function go (o, p) {
  *
  *  A valid object is
  *
+ *  ```javascript
  *    { fieldName: 'field Value' }
+ *  ```
  *
  *  A valid string is
  *
+ *  ```javascript
  *    /:fieldName
+ *  ```
  */
 export function to (o, p) {
   return (
-    p.replace(/(?::)(\w+)/g, (m, k) => m ? has(o, k) ? get(o, k) : m : m)
+    p.replace(/(?::)(\w+)/g, (m, k) => m ? has(o, k) ? String(get(o, k)) : m : m)
   )
 }
 
 export default class Rails {
   /**
-   *  @param {string | undefined} p   The 'pattern' according to which URLs should be created
+   *  @param {string | undefined} [p]   The 'pattern' according to which URLs should be created
    *  @return {string}
    */
   static pattern (p) {
-    return (
+    return ( // @ts-ignore
       p ? (pattern = String(p)) : pattern || (pattern = PATTERN)
     )
   }
 
   /**
-   *  @param {string | undefined} p   The 'pattern' according to which URLs should be created
+   *  @param {string} [p]   The 'pattern' according to which URLs should be created
    *  @return {string}
    */
   static rail (p = Rails.pattern()) {
@@ -122,8 +128,8 @@ export default class Rails {
   }
 
   /**
-   *  @param {Record<PropertyKey, unknown> | undefined} o   The object containing values for the 'pattern'
-   *  @param {string | undefined} p   The 'pattern' according to which URLs should be created
+   *  @param {Record<PropertyKey, unknown>} [o]   The object containing values for the 'pattern'
+   *  @param {string | undefined} [p]   The 'pattern' according to which URLs should be created
    *  @return {boolean}
    */
   static go (o = {}, p = Rails.pattern()) {
@@ -133,9 +139,9 @@ export default class Rails {
   }
 
   /**
-   *  @param {Record<PropertyKey, unknown> | undefined} o   The object containing values for the 'pattern'
-   *  @param {string | undefined} p   The 'pattern' according to which URLs should be created
-   *  @return {boolean}
+   *  @param {Record<PropertyKey, unknown>} [o]   The object containing values for the 'pattern'
+   *  @param {string} [p]  The 'pattern' according to which URLs should be created
+   *  @return {string}
    */
   static to (o = {}, p = Rails.pattern()) {
     return ( // eslint-disable-next-line no-cond-assign