svelte-docinfo 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -7
- package/dist/analyze-core.d.ts +20 -0
- package/dist/analyze-core.d.ts.map +1 -1
- package/dist/dep-resolver.d.ts +10 -0
- package/dist/dep-resolver.d.ts.map +1 -1
- package/dist/dep-resolver.js +11 -0
- package/dist/exports.d.ts.map +1 -1
- package/dist/exports.js +4 -1
- package/dist/session.d.ts.map +1 -1
- package/dist/session.js +7 -1
- package/dist/tsdoc.d.ts.map +1 -1
- package/dist/tsdoc.js +10 -2
- package/dist/types.d.ts +752 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +16 -0
- package/dist/typescript-extract-shared.d.ts.map +1 -1
- package/dist/typescript-extract-shared.js +23 -2
- package/dist/vite.d.ts.map +1 -1
- package/dist/vite.js +14 -22
- package/package.json +9 -8
package/dist/types.d.ts
CHANGED
|
@@ -141,6 +141,22 @@ export declare const ParameterJson: z.ZodObject<{
|
|
|
141
141
|
description: z.ZodOptional<z.ZodString>;
|
|
142
142
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
143
143
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
144
|
+
/**
|
|
145
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
146
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
147
|
+
*
|
|
148
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
149
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
150
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
151
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
152
|
+
* this parameter. Only populated for function/method/constructor
|
|
153
|
+
* signature parameters.
|
|
154
|
+
*
|
|
155
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
156
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
157
|
+
* author-facing identifier for a `@param` key to reference.
|
|
158
|
+
*/
|
|
159
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
144
160
|
}, z.core.$strict>;
|
|
145
161
|
export type ParameterJson = z.infer<typeof ParameterJson>;
|
|
146
162
|
export type ParameterJsonInput = z.input<typeof ParameterJson>;
|
|
@@ -195,6 +211,22 @@ export declare const ComponentPropJson: z.ZodObject<{
|
|
|
195
211
|
description: z.ZodOptional<z.ZodString>;
|
|
196
212
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
197
213
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
214
|
+
/**
|
|
215
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
216
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
217
|
+
*
|
|
218
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
219
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
220
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
221
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
222
|
+
* this parameter. Only populated for function/method/constructor
|
|
223
|
+
* signature parameters.
|
|
224
|
+
*
|
|
225
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
226
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
227
|
+
* author-facing identifier for a `@param` key to reference.
|
|
228
|
+
*/
|
|
229
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
198
230
|
}, z.core.$strict>>>;
|
|
199
231
|
}, z.core.$strict>;
|
|
200
232
|
export type ComponentPropJson = z.infer<typeof ComponentPropJson>;
|
|
@@ -222,6 +254,22 @@ export declare const OverloadJson: z.ZodObject<{
|
|
|
222
254
|
description: z.ZodOptional<z.ZodString>;
|
|
223
255
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
224
256
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
257
|
+
/**
|
|
258
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
259
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
260
|
+
*
|
|
261
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
262
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
263
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
264
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
265
|
+
* this parameter. Only populated for function/method/constructor
|
|
266
|
+
* signature parameters.
|
|
267
|
+
*
|
|
268
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
269
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
270
|
+
* author-facing identifier for a `@param` key to reference.
|
|
271
|
+
*/
|
|
272
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
225
273
|
}, z.core.$strict>>>;
|
|
226
274
|
/** Return type for this overload. */
|
|
227
275
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -294,6 +342,22 @@ export declare const FunctionMemberJson: z.ZodObject<{
|
|
|
294
342
|
description: z.ZodOptional<z.ZodString>;
|
|
295
343
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
296
344
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
345
|
+
/**
|
|
346
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
347
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
348
|
+
*
|
|
349
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
350
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
351
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
352
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
353
|
+
* this parameter. Only populated for function/method/constructor
|
|
354
|
+
* signature parameters.
|
|
355
|
+
*
|
|
356
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
357
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
358
|
+
* author-facing identifier for a `@param` key to reference.
|
|
359
|
+
*/
|
|
360
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
297
361
|
}, z.core.$strict>>>;
|
|
298
362
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
299
363
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -312,6 +376,22 @@ export declare const FunctionMemberJson: z.ZodObject<{
|
|
|
312
376
|
description: z.ZodOptional<z.ZodString>;
|
|
313
377
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
314
378
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
379
|
+
/**
|
|
380
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
381
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
382
|
+
*
|
|
383
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
384
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
385
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
386
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
387
|
+
* this parameter. Only populated for function/method/constructor
|
|
388
|
+
* signature parameters.
|
|
389
|
+
*
|
|
390
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
391
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
392
|
+
* author-facing identifier for a `@param` key to reference.
|
|
393
|
+
*/
|
|
394
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
315
395
|
}, z.core.$strict>>>;
|
|
316
396
|
/** Return type for this overload. */
|
|
317
397
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -444,6 +524,22 @@ export declare const ConstructorMemberJson: z.ZodObject<{
|
|
|
444
524
|
description: z.ZodOptional<z.ZodString>;
|
|
445
525
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
446
526
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
527
|
+
/**
|
|
528
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
529
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
530
|
+
*
|
|
531
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
532
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
533
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
534
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
535
|
+
* this parameter. Only populated for function/method/constructor
|
|
536
|
+
* signature parameters.
|
|
537
|
+
*
|
|
538
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
539
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
540
|
+
* author-facing identifier for a `@param` key to reference.
|
|
541
|
+
*/
|
|
542
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
447
543
|
}, z.core.$strict>>>;
|
|
448
544
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
449
545
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -462,6 +558,22 @@ export declare const ConstructorMemberJson: z.ZodObject<{
|
|
|
462
558
|
description: z.ZodOptional<z.ZodString>;
|
|
463
559
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
464
560
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
561
|
+
/**
|
|
562
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
563
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
564
|
+
*
|
|
565
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
566
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
567
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
568
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
569
|
+
* this parameter. Only populated for function/method/constructor
|
|
570
|
+
* signature parameters.
|
|
571
|
+
*
|
|
572
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
573
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
574
|
+
* author-facing identifier for a `@param` key to reference.
|
|
575
|
+
*/
|
|
576
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
465
577
|
}, z.core.$strict>>>;
|
|
466
578
|
/** Return type for this overload. */
|
|
467
579
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -548,6 +660,22 @@ export declare const FunctionDeclarationJson: z.ZodObject<{
|
|
|
548
660
|
description: z.ZodOptional<z.ZodString>;
|
|
549
661
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
550
662
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
663
|
+
/**
|
|
664
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
665
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
666
|
+
*
|
|
667
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
668
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
669
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
670
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
671
|
+
* this parameter. Only populated for function/method/constructor
|
|
672
|
+
* signature parameters.
|
|
673
|
+
*
|
|
674
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
675
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
676
|
+
* author-facing identifier for a `@param` key to reference.
|
|
677
|
+
*/
|
|
678
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
551
679
|
}, z.core.$strict>>>;
|
|
552
680
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
553
681
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -566,6 +694,22 @@ export declare const FunctionDeclarationJson: z.ZodObject<{
|
|
|
566
694
|
description: z.ZodOptional<z.ZodString>;
|
|
567
695
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
568
696
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
697
|
+
/**
|
|
698
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
699
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
700
|
+
*
|
|
701
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
702
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
703
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
704
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
705
|
+
* this parameter. Only populated for function/method/constructor
|
|
706
|
+
* signature parameters.
|
|
707
|
+
*
|
|
708
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
709
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
710
|
+
* author-facing identifier for a `@param` key to reference.
|
|
711
|
+
*/
|
|
712
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
569
713
|
}, z.core.$strict>>>;
|
|
570
714
|
/** Return type for this overload. */
|
|
571
715
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -661,6 +805,22 @@ export declare const ClassDeclarationJson: z.ZodObject<{
|
|
|
661
805
|
description: z.ZodOptional<z.ZodString>;
|
|
662
806
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
663
807
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
808
|
+
/**
|
|
809
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
810
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
811
|
+
*
|
|
812
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
813
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
814
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
815
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
816
|
+
* this parameter. Only populated for function/method/constructor
|
|
817
|
+
* signature parameters.
|
|
818
|
+
*
|
|
819
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
820
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
821
|
+
* author-facing identifier for a `@param` key to reference.
|
|
822
|
+
*/
|
|
823
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
664
824
|
}, z.core.$strict>>>;
|
|
665
825
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
666
826
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -679,6 +839,22 @@ export declare const ClassDeclarationJson: z.ZodObject<{
|
|
|
679
839
|
description: z.ZodOptional<z.ZodString>;
|
|
680
840
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
681
841
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
842
|
+
/**
|
|
843
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
844
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
845
|
+
*
|
|
846
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
847
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
848
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
849
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
850
|
+
* this parameter. Only populated for function/method/constructor
|
|
851
|
+
* signature parameters.
|
|
852
|
+
*
|
|
853
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
854
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
855
|
+
* author-facing identifier for a `@param` key to reference.
|
|
856
|
+
*/
|
|
857
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
682
858
|
}, z.core.$strict>>>;
|
|
683
859
|
/** Return type for this overload. */
|
|
684
860
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -786,6 +962,22 @@ export declare const ClassDeclarationJson: z.ZodObject<{
|
|
|
786
962
|
description: z.ZodOptional<z.ZodString>;
|
|
787
963
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
788
964
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
965
|
+
/**
|
|
966
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
967
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
968
|
+
*
|
|
969
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
970
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
971
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
972
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
973
|
+
* this parameter. Only populated for function/method/constructor
|
|
974
|
+
* signature parameters.
|
|
975
|
+
*
|
|
976
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
977
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
978
|
+
* author-facing identifier for a `@param` key to reference.
|
|
979
|
+
*/
|
|
980
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
789
981
|
}, z.core.$strict>>>;
|
|
790
982
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
791
983
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -804,6 +996,22 @@ export declare const ClassDeclarationJson: z.ZodObject<{
|
|
|
804
996
|
description: z.ZodOptional<z.ZodString>;
|
|
805
997
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
806
998
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
999
|
+
/**
|
|
1000
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1001
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1002
|
+
*
|
|
1003
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1004
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1005
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1006
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1007
|
+
* this parameter. Only populated for function/method/constructor
|
|
1008
|
+
* signature parameters.
|
|
1009
|
+
*
|
|
1010
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1011
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1012
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1013
|
+
*/
|
|
1014
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
807
1015
|
}, z.core.$strict>>>;
|
|
808
1016
|
/** Return type for this overload. */
|
|
809
1017
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -929,6 +1137,22 @@ export declare const InterfaceDeclarationJson: z.ZodObject<{
|
|
|
929
1137
|
description: z.ZodOptional<z.ZodString>;
|
|
930
1138
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
931
1139
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1142
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1143
|
+
*
|
|
1144
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1145
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1146
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1147
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1148
|
+
* this parameter. Only populated for function/method/constructor
|
|
1149
|
+
* signature parameters.
|
|
1150
|
+
*
|
|
1151
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1152
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1153
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1154
|
+
*/
|
|
1155
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
932
1156
|
}, z.core.$strict>>>;
|
|
933
1157
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
934
1158
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -947,6 +1171,22 @@ export declare const InterfaceDeclarationJson: z.ZodObject<{
|
|
|
947
1171
|
description: z.ZodOptional<z.ZodString>;
|
|
948
1172
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
949
1173
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1174
|
+
/**
|
|
1175
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1176
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1177
|
+
*
|
|
1178
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1179
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1180
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1181
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1182
|
+
* this parameter. Only populated for function/method/constructor
|
|
1183
|
+
* signature parameters.
|
|
1184
|
+
*
|
|
1185
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1186
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1187
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1188
|
+
*/
|
|
1189
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
950
1190
|
}, z.core.$strict>>>;
|
|
951
1191
|
/** Return type for this overload. */
|
|
952
1192
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -1054,6 +1294,22 @@ export declare const InterfaceDeclarationJson: z.ZodObject<{
|
|
|
1054
1294
|
description: z.ZodOptional<z.ZodString>;
|
|
1055
1295
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1056
1296
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1297
|
+
/**
|
|
1298
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1299
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1300
|
+
*
|
|
1301
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1302
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1303
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1304
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1305
|
+
* this parameter. Only populated for function/method/constructor
|
|
1306
|
+
* signature parameters.
|
|
1307
|
+
*
|
|
1308
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1309
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1310
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1311
|
+
*/
|
|
1312
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1057
1313
|
}, z.core.$strict>>>;
|
|
1058
1314
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
1059
1315
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -1072,6 +1328,22 @@ export declare const InterfaceDeclarationJson: z.ZodObject<{
|
|
|
1072
1328
|
description: z.ZodOptional<z.ZodString>;
|
|
1073
1329
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1074
1330
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1333
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1334
|
+
*
|
|
1335
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1336
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1337
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1338
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1339
|
+
* this parameter. Only populated for function/method/constructor
|
|
1340
|
+
* signature parameters.
|
|
1341
|
+
*
|
|
1342
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1343
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1344
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1345
|
+
*/
|
|
1346
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1075
1347
|
}, z.core.$strict>>>;
|
|
1076
1348
|
/** Return type for this overload. */
|
|
1077
1349
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -1197,6 +1469,22 @@ export declare const TypeDeclarationJson: z.ZodObject<{
|
|
|
1197
1469
|
description: z.ZodOptional<z.ZodString>;
|
|
1198
1470
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1199
1471
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1472
|
+
/**
|
|
1473
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1474
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1475
|
+
*
|
|
1476
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1477
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1478
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1479
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1480
|
+
* this parameter. Only populated for function/method/constructor
|
|
1481
|
+
* signature parameters.
|
|
1482
|
+
*
|
|
1483
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1484
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1485
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1486
|
+
*/
|
|
1487
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1200
1488
|
}, z.core.$strict>>>;
|
|
1201
1489
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
1202
1490
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -1215,6 +1503,22 @@ export declare const TypeDeclarationJson: z.ZodObject<{
|
|
|
1215
1503
|
description: z.ZodOptional<z.ZodString>;
|
|
1216
1504
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1217
1505
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1506
|
+
/**
|
|
1507
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1508
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1509
|
+
*
|
|
1510
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1511
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1512
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1513
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1514
|
+
* this parameter. Only populated for function/method/constructor
|
|
1515
|
+
* signature parameters.
|
|
1516
|
+
*
|
|
1517
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1518
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1519
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1520
|
+
*/
|
|
1521
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1218
1522
|
}, z.core.$strict>>>;
|
|
1219
1523
|
/** Return type for this overload. */
|
|
1220
1524
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -1322,6 +1626,22 @@ export declare const TypeDeclarationJson: z.ZodObject<{
|
|
|
1322
1626
|
description: z.ZodOptional<z.ZodString>;
|
|
1323
1627
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1324
1628
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1629
|
+
/**
|
|
1630
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1631
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1632
|
+
*
|
|
1633
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1634
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1635
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1636
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1637
|
+
* this parameter. Only populated for function/method/constructor
|
|
1638
|
+
* signature parameters.
|
|
1639
|
+
*
|
|
1640
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1641
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1642
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1643
|
+
*/
|
|
1644
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1325
1645
|
}, z.core.$strict>>>;
|
|
1326
1646
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
1327
1647
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -1340,6 +1660,22 @@ export declare const TypeDeclarationJson: z.ZodObject<{
|
|
|
1340
1660
|
description: z.ZodOptional<z.ZodString>;
|
|
1341
1661
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1342
1662
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1663
|
+
/**
|
|
1664
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1665
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1666
|
+
*
|
|
1667
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1668
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1669
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1670
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1671
|
+
* this parameter. Only populated for function/method/constructor
|
|
1672
|
+
* signature parameters.
|
|
1673
|
+
*
|
|
1674
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1675
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1676
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1677
|
+
*/
|
|
1678
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1343
1679
|
}, z.core.$strict>>>;
|
|
1344
1680
|
/** Return type for this overload. */
|
|
1345
1681
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -1507,6 +1843,22 @@ export declare const EnumDeclarationJson: z.ZodObject<{
|
|
|
1507
1843
|
description: z.ZodOptional<z.ZodString>;
|
|
1508
1844
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1509
1845
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1846
|
+
/**
|
|
1847
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1848
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1849
|
+
*
|
|
1850
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1851
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1852
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1853
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1854
|
+
* this parameter. Only populated for function/method/constructor
|
|
1855
|
+
* signature parameters.
|
|
1856
|
+
*
|
|
1857
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1858
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1859
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1860
|
+
*/
|
|
1861
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1510
1862
|
}, z.core.$strict>>>;
|
|
1511
1863
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
1512
1864
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -1525,6 +1877,22 @@ export declare const EnumDeclarationJson: z.ZodObject<{
|
|
|
1525
1877
|
description: z.ZodOptional<z.ZodString>;
|
|
1526
1878
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1527
1879
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
1880
|
+
/**
|
|
1881
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
1882
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
1883
|
+
*
|
|
1884
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
1885
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
1886
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
1887
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
1888
|
+
* this parameter. Only populated for function/method/constructor
|
|
1889
|
+
* signature parameters.
|
|
1890
|
+
*
|
|
1891
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
1892
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
1893
|
+
* author-facing identifier for a `@param` key to reference.
|
|
1894
|
+
*/
|
|
1895
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1528
1896
|
}, z.core.$strict>>>;
|
|
1529
1897
|
/** Return type for this overload. */
|
|
1530
1898
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -1632,6 +2000,22 @@ export declare const EnumDeclarationJson: z.ZodObject<{
|
|
|
1632
2000
|
description: z.ZodOptional<z.ZodString>;
|
|
1633
2001
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1634
2002
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2003
|
+
/**
|
|
2004
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2005
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2006
|
+
*
|
|
2007
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2008
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2009
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2010
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2011
|
+
* this parameter. Only populated for function/method/constructor
|
|
2012
|
+
* signature parameters.
|
|
2013
|
+
*
|
|
2014
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2015
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2016
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2017
|
+
*/
|
|
2018
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1635
2019
|
}, z.core.$strict>>>;
|
|
1636
2020
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
1637
2021
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -1650,6 +2034,22 @@ export declare const EnumDeclarationJson: z.ZodObject<{
|
|
|
1650
2034
|
description: z.ZodOptional<z.ZodString>;
|
|
1651
2035
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1652
2036
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2037
|
+
/**
|
|
2038
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2039
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2040
|
+
*
|
|
2041
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2042
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2043
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2044
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2045
|
+
* this parameter. Only populated for function/method/constructor
|
|
2046
|
+
* signature parameters.
|
|
2047
|
+
*
|
|
2048
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2049
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2050
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2051
|
+
*/
|
|
2052
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1653
2053
|
}, z.core.$strict>>>;
|
|
1654
2054
|
/** Return type for this overload. */
|
|
1655
2055
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -1791,6 +2191,22 @@ export declare const ComponentDeclarationJson: z.ZodObject<{
|
|
|
1791
2191
|
description: z.ZodOptional<z.ZodString>;
|
|
1792
2192
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1793
2193
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2194
|
+
/**
|
|
2195
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2196
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2197
|
+
*
|
|
2198
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2199
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2200
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2201
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2202
|
+
* this parameter. Only populated for function/method/constructor
|
|
2203
|
+
* signature parameters.
|
|
2204
|
+
*
|
|
2205
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2206
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2207
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2208
|
+
*/
|
|
2209
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1794
2210
|
}, z.core.$strict>>>;
|
|
1795
2211
|
}, z.core.$strict>>>;
|
|
1796
2212
|
/** Whether the component accepts children (explicit `children` prop, inherited, or implicit template usage). */
|
|
@@ -1854,6 +2270,22 @@ export declare const SnippetDeclarationJson: z.ZodObject<{
|
|
|
1854
2270
|
description: z.ZodOptional<z.ZodString>;
|
|
1855
2271
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1856
2272
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2273
|
+
/**
|
|
2274
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2275
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2276
|
+
*
|
|
2277
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2278
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2279
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2280
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2281
|
+
* this parameter. Only populated for function/method/constructor
|
|
2282
|
+
* signature parameters.
|
|
2283
|
+
*
|
|
2284
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2285
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2286
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2287
|
+
*/
|
|
2288
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1857
2289
|
}, z.core.$strict>>>;
|
|
1858
2290
|
alsoExportedFrom: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
1859
2291
|
aliasOf: z.ZodOptional<z.ZodObject<{
|
|
@@ -1994,6 +2426,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
1994
2426
|
description: z.ZodOptional<z.ZodString>;
|
|
1995
2427
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
1996
2428
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2429
|
+
/**
|
|
2430
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2431
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2432
|
+
*
|
|
2433
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2434
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2435
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2436
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2437
|
+
* this parameter. Only populated for function/method/constructor
|
|
2438
|
+
* signature parameters.
|
|
2439
|
+
*
|
|
2440
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2441
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2442
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2443
|
+
*/
|
|
2444
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
1997
2445
|
}, z.core.$strict>>>;
|
|
1998
2446
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
1999
2447
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -2012,6 +2460,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2012
2460
|
description: z.ZodOptional<z.ZodString>;
|
|
2013
2461
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2014
2462
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2463
|
+
/**
|
|
2464
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2465
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2466
|
+
*
|
|
2467
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2468
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2469
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2470
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2471
|
+
* this parameter. Only populated for function/method/constructor
|
|
2472
|
+
* signature parameters.
|
|
2473
|
+
*
|
|
2474
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2475
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2476
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2477
|
+
*/
|
|
2478
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2015
2479
|
}, z.core.$strict>>>;
|
|
2016
2480
|
/** Return type for this overload. */
|
|
2017
2481
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -2104,6 +2568,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2104
2568
|
description: z.ZodOptional<z.ZodString>;
|
|
2105
2569
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2106
2570
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2571
|
+
/**
|
|
2572
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2573
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2574
|
+
*
|
|
2575
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2576
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2577
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2578
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2579
|
+
* this parameter. Only populated for function/method/constructor
|
|
2580
|
+
* signature parameters.
|
|
2581
|
+
*
|
|
2582
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2583
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2584
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2585
|
+
*/
|
|
2586
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2107
2587
|
}, z.core.$strict>>>;
|
|
2108
2588
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
2109
2589
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -2122,6 +2602,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2122
2602
|
description: z.ZodOptional<z.ZodString>;
|
|
2123
2603
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2124
2604
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2605
|
+
/**
|
|
2606
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2607
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2608
|
+
*
|
|
2609
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2610
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2611
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2612
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2613
|
+
* this parameter. Only populated for function/method/constructor
|
|
2614
|
+
* signature parameters.
|
|
2615
|
+
*
|
|
2616
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2617
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2618
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2619
|
+
*/
|
|
2620
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2125
2621
|
}, z.core.$strict>>>;
|
|
2126
2622
|
/** Return type for this overload. */
|
|
2127
2623
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -2229,6 +2725,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2229
2725
|
description: z.ZodOptional<z.ZodString>;
|
|
2230
2726
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2231
2727
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2728
|
+
/**
|
|
2729
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2730
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2731
|
+
*
|
|
2732
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2733
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2734
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2735
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2736
|
+
* this parameter. Only populated for function/method/constructor
|
|
2737
|
+
* signature parameters.
|
|
2738
|
+
*
|
|
2739
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2740
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2741
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2742
|
+
*/
|
|
2743
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2232
2744
|
}, z.core.$strict>>>;
|
|
2233
2745
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
2234
2746
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -2247,6 +2759,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2247
2759
|
description: z.ZodOptional<z.ZodString>;
|
|
2248
2760
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2249
2761
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2762
|
+
/**
|
|
2763
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2764
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2765
|
+
*
|
|
2766
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2767
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2768
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2769
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2770
|
+
* this parameter. Only populated for function/method/constructor
|
|
2771
|
+
* signature parameters.
|
|
2772
|
+
*
|
|
2773
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2774
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2775
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2776
|
+
*/
|
|
2777
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2250
2778
|
}, z.core.$strict>>>;
|
|
2251
2779
|
/** Return type for this overload. */
|
|
2252
2780
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -2369,6 +2897,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2369
2897
|
description: z.ZodOptional<z.ZodString>;
|
|
2370
2898
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2371
2899
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2900
|
+
/**
|
|
2901
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2902
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2903
|
+
*
|
|
2904
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2905
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2906
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2907
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2908
|
+
* this parameter. Only populated for function/method/constructor
|
|
2909
|
+
* signature parameters.
|
|
2910
|
+
*
|
|
2911
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2912
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2913
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2914
|
+
*/
|
|
2915
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2372
2916
|
}, z.core.$strict>>>;
|
|
2373
2917
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
2374
2918
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -2387,6 +2931,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2387
2931
|
description: z.ZodOptional<z.ZodString>;
|
|
2388
2932
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2389
2933
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
2934
|
+
/**
|
|
2935
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
2936
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
2937
|
+
*
|
|
2938
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
2939
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
2940
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
2941
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
2942
|
+
* this parameter. Only populated for function/method/constructor
|
|
2943
|
+
* signature parameters.
|
|
2944
|
+
*
|
|
2945
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
2946
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
2947
|
+
* author-facing identifier for a `@param` key to reference.
|
|
2948
|
+
*/
|
|
2949
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2390
2950
|
}, z.core.$strict>>>;
|
|
2391
2951
|
/** Return type for this overload. */
|
|
2392
2952
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -2494,6 +3054,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2494
3054
|
description: z.ZodOptional<z.ZodString>;
|
|
2495
3055
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2496
3056
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3057
|
+
/**
|
|
3058
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3059
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3060
|
+
*
|
|
3061
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3062
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3063
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3064
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3065
|
+
* this parameter. Only populated for function/method/constructor
|
|
3066
|
+
* signature parameters.
|
|
3067
|
+
*
|
|
3068
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3069
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3070
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3071
|
+
*/
|
|
3072
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2497
3073
|
}, z.core.$strict>>>;
|
|
2498
3074
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
2499
3075
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -2512,6 +3088,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2512
3088
|
description: z.ZodOptional<z.ZodString>;
|
|
2513
3089
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2514
3090
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3091
|
+
/**
|
|
3092
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3093
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3094
|
+
*
|
|
3095
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3096
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3097
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3098
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3099
|
+
* this parameter. Only populated for function/method/constructor
|
|
3100
|
+
* signature parameters.
|
|
3101
|
+
*
|
|
3102
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3103
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3104
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3105
|
+
*/
|
|
3106
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2515
3107
|
}, z.core.$strict>>>;
|
|
2516
3108
|
/** Return type for this overload. */
|
|
2517
3109
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -2634,6 +3226,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2634
3226
|
description: z.ZodOptional<z.ZodString>;
|
|
2635
3227
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2636
3228
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3229
|
+
/**
|
|
3230
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3231
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3232
|
+
*
|
|
3233
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3234
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3235
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3236
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3237
|
+
* this parameter. Only populated for function/method/constructor
|
|
3238
|
+
* signature parameters.
|
|
3239
|
+
*
|
|
3240
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3241
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3242
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3243
|
+
*/
|
|
3244
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2637
3245
|
}, z.core.$strict>>>;
|
|
2638
3246
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
2639
3247
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -2652,6 +3260,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2652
3260
|
description: z.ZodOptional<z.ZodString>;
|
|
2653
3261
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2654
3262
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3263
|
+
/**
|
|
3264
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3265
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3266
|
+
*
|
|
3267
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3268
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3269
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3270
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3271
|
+
* this parameter. Only populated for function/method/constructor
|
|
3272
|
+
* signature parameters.
|
|
3273
|
+
*
|
|
3274
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3275
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3276
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3277
|
+
*/
|
|
3278
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2655
3279
|
}, z.core.$strict>>>;
|
|
2656
3280
|
/** Return type for this overload. */
|
|
2657
3281
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -2759,6 +3383,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2759
3383
|
description: z.ZodOptional<z.ZodString>;
|
|
2760
3384
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2761
3385
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3386
|
+
/**
|
|
3387
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3388
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3389
|
+
*
|
|
3390
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3391
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3392
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3393
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3394
|
+
* this parameter. Only populated for function/method/constructor
|
|
3395
|
+
* signature parameters.
|
|
3396
|
+
*
|
|
3397
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3398
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3399
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3400
|
+
*/
|
|
3401
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2762
3402
|
}, z.core.$strict>>>;
|
|
2763
3403
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
2764
3404
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -2777,6 +3417,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2777
3417
|
description: z.ZodOptional<z.ZodString>;
|
|
2778
3418
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2779
3419
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3420
|
+
/**
|
|
3421
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3422
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3423
|
+
*
|
|
3424
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3425
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3426
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3427
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3428
|
+
* this parameter. Only populated for function/method/constructor
|
|
3429
|
+
* signature parameters.
|
|
3430
|
+
*
|
|
3431
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3432
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3433
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3434
|
+
*/
|
|
3435
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2780
3436
|
}, z.core.$strict>>>;
|
|
2781
3437
|
/** Return type for this overload. */
|
|
2782
3438
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -2935,6 +3591,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2935
3591
|
description: z.ZodOptional<z.ZodString>;
|
|
2936
3592
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2937
3593
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3594
|
+
/**
|
|
3595
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3596
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3597
|
+
*
|
|
3598
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3599
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3600
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3601
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3602
|
+
* this parameter. Only populated for function/method/constructor
|
|
3603
|
+
* signature parameters.
|
|
3604
|
+
*
|
|
3605
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3606
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3607
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3608
|
+
*/
|
|
3609
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2938
3610
|
}, z.core.$strict>>>;
|
|
2939
3611
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
2940
3612
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -2953,6 +3625,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
2953
3625
|
description: z.ZodOptional<z.ZodString>;
|
|
2954
3626
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
2955
3627
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3628
|
+
/**
|
|
3629
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3630
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3631
|
+
*
|
|
3632
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3633
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3634
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3635
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3636
|
+
* this parameter. Only populated for function/method/constructor
|
|
3637
|
+
* signature parameters.
|
|
3638
|
+
*
|
|
3639
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3640
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3641
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3642
|
+
*/
|
|
3643
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
2956
3644
|
}, z.core.$strict>>>;
|
|
2957
3645
|
/** Return type for this overload. */
|
|
2958
3646
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -3060,6 +3748,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
3060
3748
|
description: z.ZodOptional<z.ZodString>;
|
|
3061
3749
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
3062
3750
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3751
|
+
/**
|
|
3752
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3753
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3754
|
+
*
|
|
3755
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3756
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3757
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3758
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3759
|
+
* this parameter. Only populated for function/method/constructor
|
|
3760
|
+
* signature parameters.
|
|
3761
|
+
*
|
|
3762
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3763
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3764
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3765
|
+
*/
|
|
3766
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
3063
3767
|
}, z.core.$strict>>>;
|
|
3064
3768
|
overloads: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
3065
3769
|
/** Full TypeScript type signature for this overload. */
|
|
@@ -3078,6 +3782,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
3078
3782
|
description: z.ZodOptional<z.ZodString>;
|
|
3079
3783
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
3080
3784
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3785
|
+
/**
|
|
3786
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3787
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3788
|
+
*
|
|
3789
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3790
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3791
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3792
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3793
|
+
* this parameter. Only populated for function/method/constructor
|
|
3794
|
+
* signature parameters.
|
|
3795
|
+
*
|
|
3796
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3797
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3798
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3799
|
+
*/
|
|
3800
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
3081
3801
|
}, z.core.$strict>>>;
|
|
3082
3802
|
/** Return type for this overload. */
|
|
3083
3803
|
returnType: z.ZodOptional<z.ZodString>;
|
|
@@ -3216,6 +3936,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
3216
3936
|
description: z.ZodOptional<z.ZodString>;
|
|
3217
3937
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
3218
3938
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
3939
|
+
/**
|
|
3940
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
3941
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
3942
|
+
*
|
|
3943
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
3944
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
3945
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
3946
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
3947
|
+
* this parameter. Only populated for function/method/constructor
|
|
3948
|
+
* signature parameters.
|
|
3949
|
+
*
|
|
3950
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
3951
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
3952
|
+
* author-facing identifier for a `@param` key to reference.
|
|
3953
|
+
*/
|
|
3954
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
3219
3955
|
}, z.core.$strict>>>;
|
|
3220
3956
|
}, z.core.$strict>>>;
|
|
3221
3957
|
/** Whether the component accepts children (explicit `children` prop, inherited, or implicit template usage). */
|
|
@@ -3276,6 +4012,22 @@ export declare const ModuleJson: z.ZodObject<{
|
|
|
3276
4012
|
description: z.ZodOptional<z.ZodString>;
|
|
3277
4013
|
/** Default value expression from the source (e.g., `'hello'`, `42`). */
|
|
3278
4014
|
defaultValue: z.ZodOptional<z.ZodString>;
|
|
4015
|
+
/**
|
|
4016
|
+
* Descriptions for properties of a named object parameter, from dotted
|
|
4017
|
+
* `@param` tags (`@param obj.prop - ...`).
|
|
4018
|
+
*
|
|
4019
|
+
* Keyed by the sub-path relative to this parameter — `@param obj.prop`
|
|
4020
|
+
* becomes `{prop: '...'}`, `@param obj.a.b` becomes `{'a.b': '...'}`.
|
|
4021
|
+
* Keys are unvalidated against the parameter's actual type (matching the
|
|
4022
|
+
* `@mutates` philosophy); absent when no dotted `@param` tags reference
|
|
4023
|
+
* this parameter. Only populated for function/method/constructor
|
|
4024
|
+
* signature parameters.
|
|
4025
|
+
*
|
|
4026
|
+
* Matching is by the parameter's name, so destructured parameters
|
|
4027
|
+
* (`fn({a, b}: T)`) are not covered — TypeScript names them `__0`, with no
|
|
4028
|
+
* author-facing identifier for a `@param` key to reference.
|
|
4029
|
+
*/
|
|
4030
|
+
propertyDescriptions: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
3279
4031
|
}, z.core.$strict>>>;
|
|
3280
4032
|
alsoExportedFrom: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
3281
4033
|
aliasOf: z.ZodOptional<z.ZodObject<{
|