shinkansen-rails 1.0.138 → 1.0.140

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-rails",
-  "version": "1.0.138",
+  "version": "1.0.140",
   "description": "Shinkansen Rails",
   "keywords": [
     "Shinkansen",
@@ -10,6 +10,8 @@
     "Karakuri"
   ],
   "main": "./src/index.cjs",
+  "type": "module",
+  "types": "./src/index.d.cts",
   "author": {
     "name": "Jonathan Perry for Modern Poacher Limited",
     "email": "modernpoacher@modernpoacher.com",
@@ -40,17 +42,17 @@
     "@babel/eslint-parser": "^7.23.10",
     "@babel/preset-env": "^7.23.9",
     "@babel/register": "^7.23.7",
-    "@modernpoacher/hooks": "^1.0.465",
+    "@modernpoacher/hooks": "^1.0.466",
     "@sequencemedia/sinon-chai": "^0.0.6",
-    "@typescript-eslint/eslint-plugin": "5.61.0",
-    "@typescript-eslint/parser": "5.61.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.2",
+    "@typescript-eslint/parser": "^7.0.2",
     "babel-plugin-module-resolver": "^5.0.0",
     "chai": "^5.1.0",
     "core-js": "^3.36.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-config-standard-with-typescript": "35.0.0",
+    "eslint-config-standard-with-typescript": "^43.0.1",
     "eslint-import-resolver-babel-module": "^5.3.2",
     "husky": "^9.0.11",
     "mocha": "^10.3.0",

package/src/index.d.cts

@@ -1,3 +1,20 @@
+declare module 'shinkansen-rails/rails' {
+  export function any (o: Record<string, unknown> | undefined): boolean
+  export function has (o: Record<string, unknown> | undefined, k: string): boolean
+  export function get (o: Record<string, unknown> | undefined, k: string): unknown
+
+  export function rail (p: string | undefined): string
+  export function go (o: Record<string, unknown> | undefined, p: string | undefined): boolean
+  export function to (o: Record<string, unknown> | undefined, p: string | undefined): boolean
+
+  export default class Rails {
+    static pattern (p: string | undefined): string
+    static rail (p: string | undefined): string
+    static go (o: Record<string, unknown> | undefined, p: string | undefined): boolean
+    static to (o: Record<string, unknown> | undefined, p: string | undefined): boolean
+  }
+}
+
 declare module 'shinkansen-rails' {
-  export { default as Rails } from './rails/index.mjs'
+  export { default as Rails } from 'shinkansen-rails/rails'
 }

package/src/rails/index.mjs

@@ -13,8 +13,21 @@ const PATTERN = '/:alpha/:omega'
 const CHAR32 = String.fromCharCode(32)
 const CHAR45 = String.fromCharCode(45)
 
+/**
+ *  @param {Record<string, unknown>} o   The object containing values
+ */
 export const any = (o) => !!Reflect.ownKeys(o).length
+
+/**
+ *  @param {Record<string, unknown>} o   The object containing values
+ *  @param {string} k   The value name
+ */
 export const has = (o, k) => Reflect.has(o, k)
+
+/**
+ *  @param {Record<string, unknown>} o   The object containing values
+ *  @param {string} k   The value name
+ */
 export const get = (o, k) => Reflect.get(o, k)
 
 /**
@@ -32,7 +45,7 @@ export function rail (p) {
 /**
  *  Interrogate parameters to determine whether or not components can be created
  *
- *  @param {{}} o   The object containing values for the 'pattern'
+ *  @param {Record<string, 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}
@@ -65,7 +78,7 @@ export function go (o, p) {
 /**
  *  Interrogate parameters for object field names
  *
- *  @param {{}} o   The object containing fields
+ *  @param {Record<string, unknown>} o   The object containing fields
  *  @param {string} p   The string containing field names to be found
  *  @return {string}
  *
@@ -87,7 +100,7 @@ export function to (o, p) {
 
 export default class Rails {
   /**
-   *  @param {string | void} 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) {
@@ -97,7 +110,7 @@ export default class Rails {
   }
 
   /**
-   *  @param {string | void} 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 rail (p = Rails.pattern()) {
@@ -109,8 +122,8 @@ export default class Rails {
   }
 
   /**
-   *  @param {{} | void} o   The object containing values for the 'pattern'
-   *  @param {string | void} p   The 'pattern' according to which URLs should be created
+   *  @param {Record<string, 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}
    */
   static go (o = {}, p = Rails.pattern()) {
@@ -120,8 +133,8 @@ export default class Rails {
   }
 
   /**
-   *  @param {{} | void} o   The object containing values for the 'pattern'
-   *  @param {string | void} p   The 'pattern' according to which URLs should be created
+   *  @param {Record<string, 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}
    */
   static to (o = {}, p = Rails.pattern()) {

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "target": "ESNext",
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "strict": true,
+    "isolatedModules": true,
+    "baseUrl": "."
+  }
+}