chore(core): improve TS type definitions

P0lip · Jul 24, 2024 · d63843a · d63843a
1 parent fa8febd
commit d63843a
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 7 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nimma",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Scalable JSONPath engine.",
   "keywords": [
     "json",

diff --git a/src/index.d.ts b/src/index.d.ts
@@ -7,16 +7,27 @@ export type EmittedScope = {
   readonly value: unknown;
 };
 
+export type Scope = {
+  sandbox: {
+    value: unknown;
+  };
+  path: (string | number)[];
+  callbacks: Record<string, Callback>;
+};
+
 export type State = {
   value: number;
   initialValue: number;
 };
 
+export type CustomShorthand = (
+  scope: Scope,
+  state: State,
+  initialValue: number,
+) => void;
+
 export type Options = {
-  customShorthands?: Record<
-    string,
-    (path: JsonPath, state?: State, initialValue?: number) => void
-  >;
+  customShorthands?: Record<string, CustomShorthand>;
   module?: 'esm' | 'commonjs';
 };