@brianbuie/node-kit 0.15.1 → 0.16.0

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/dist/index.d.mts CHANGED
@@ -1,16 +1,8 @@
1
1
  import * as fs from "node:fs";
2
2
  import { Readable } from "node:stream";
3
3
  import { DateArg, Duration } from "date-fns";
4
+ import pino, { Logger } from "pino";
4
5
  import * as qt from "quicktype-core";
5
- import * as quicktype_core_dist_TargetLanguage_js0 from "quicktype-core/dist/TargetLanguage.js";
6
- import * as quicktype_core_dist_support_Comments_js0 from "quicktype-core/dist/support/Comments.js";
7
- import * as quicktype_core_dist_RendererOptions_index_js0 from "quicktype-core/dist/RendererOptions/index.js";
8
- import * as quicktype_core_dist_RendererOptions_types_js0 from "quicktype-core/dist/RendererOptions/types.js";
9
- import * as quicktype_core_dist_support_Acronyms_js0 from "quicktype-core/dist/support/Acronyms.js";
10
- import * as quicktype_core_dist_support_Converters_js0 from "quicktype-core/dist/support/Converters.js";
11
- import * as quicktype_core_dist_language_Ruby_utils_js0 from "quicktype-core/dist/language/Ruby/utils.js";
12
- import * as quicktype_core_dist_language_Rust_utils_js0 from "quicktype-core/dist/language/Rust/utils.js";
13
- import * as quicktype_core_dist_language_Smithy4s_language_js0 from "quicktype-core/dist/language/Smithy4s/language.js";
14
6
 
15
7
  //#region src/File.d.ts
16
8
  /**
@@ -24,7 +16,7 @@ declare class File {
24
16
  base: string;
25
17
  name: string;
26
18
  ext: string;
27
- type: string | undefined;
19
+ type?: string;
28
20
  constructor(filepath: string);
29
21
  get exists(): boolean;
30
22
  get stats(): Partial<fs.Stats>;
@@ -82,7 +74,7 @@ declare class File {
82
74
  * await file.write({ col: 'val' }); // ✅ Writes one row
83
75
  * await file.write([{ col: 'val2' }, { col: 'val3' }]); // ✅ Writes multiple rows
84
76
  */
85
- csv<T extends object>(rows?: T[], keys?: (keyof T)[]): Promise<FileTypeCsv<T>>;
77
+ csv<T extends object>(rows?: T[], options?: FileTypeCsvOptions<T>): Promise<FileTypeCsv<T>>;
86
78
  static get csv(): typeof FileTypeCsv;
87
79
  }
88
80
  /**
@@ -106,7 +98,7 @@ declare class FileType {
106
98
  }
107
99
  /**
108
100
  * A .json file that maintains data type when reading/writing.
109
- * > ⚠️ This is mildly unsafe, important/foreign json files should be validated at runtime!
101
+ * > ⚠️ This is mildly unsafe, json files should be validated at runtime!
110
102
  * @example
111
103
  * const file = new FileTypeJson('./data', { key: 'val' }); // FileTypeJson<{ key: string; }>
112
104
  * console.log(file.path) // '/path/to/cwd/data.json'
@@ -130,14 +122,21 @@ declare class FileTypeNdjson<T extends object> extends FileType {
130
122
  lines(): T[];
131
123
  }
132
124
  type Key<T extends object> = keyof T;
125
+ type FileTypeCsvOptions<Row extends object> = {
126
+ parseNumbers?: boolean;
127
+ parseBooleans?: boolean;
128
+ parseNulls?: boolean;
129
+ keys?: Key<Row>[];
130
+ };
133
131
  /**
134
132
  * Comma separated values (.csv).
135
133
  * Input rows as objects, keys are used as column headers
136
134
  */
137
135
  declare class FileTypeCsv<Row extends object> extends FileType {
138
136
  #private;
139
- constructor(filepath: string);
140
- write(rows: Row[], keys?: Key<Row>[]): Promise<void>;
137
+ options: FileTypeCsvOptions<Row>;
138
+ constructor(filepath: string, options?: FileTypeCsvOptions<Row>);
139
+ write(rows: Row[]): Promise<void>;
141
140
  read(): Promise<Row[]>;
142
141
  }
143
142
  //#endregion
@@ -187,12 +186,12 @@ declare class Dir {
187
186
  * const child = folder.dir('path/to/dir');
188
187
  * // child.path = '/path/to/cwd/example/path/to/dir'
189
188
  */
190
- dir(subPath?: string, options?: DirOptions): this;
189
+ dir(subPath?: string, options?: DirOptions): Dir;
191
190
  /**
192
191
  * Creates a new temp directory inside current Dir
193
192
  * @param subPath joined with parent Dir's path to make new TempDir
194
193
  */
195
- tempDir(subPath?: string): this;
194
+ tempDir(subPath?: string): Dir;
196
195
  sanitize(filename: string): string;
197
196
  /**
198
197
  * @param base - The file base (name and extension)
@@ -253,7 +252,7 @@ declare class Dir {
253
252
  /**
254
253
  * All files with ext ".txt"
255
254
  */
256
- get textFiles(): File[];
255
+ get txtFiles(): File[];
257
256
  /**
258
257
  * Deletes the contents of the directory. Only allowed if created with `temp` option set to `true` (or created with `dir.tempDir` method).
259
258
  */
@@ -304,28 +303,7 @@ type FetchOptions = RequestInit & {
304
303
  * Includes basic methods for requesting and parsing responses
305
304
  */
306
305
  declare class Fetcher {
307
- defaultOptions: {
308
- body?: BodyInit | null;
309
- cache?: RequestCache;
310
- credentials?: RequestCredentials;
311
- headers?: (HeadersInit & Record<string, string>) | undefined;
312
- integrity?: string;
313
- keepalive?: boolean;
314
- method?: string;
315
- mode?: RequestMode;
316
- priority?: RequestPriority;
317
- redirect?: RequestRedirect;
318
- referrer?: string;
319
- referrerPolicy?: ReferrerPolicy;
320
- signal?: AbortSignal | null;
321
- window?: null;
322
- base?: string;
323
- query?: Query;
324
- data?: any;
325
- timeout: number;
326
- retries: number;
327
- retryDelay: number;
328
- };
306
+ defaultOptions: FetchOptions;
329
307
  constructor(opts?: FetchOptions);
330
308
  /**
331
309
  * Build URL with URLSearchParams if query is provided.
@@ -390,505 +368,54 @@ declare class Format {
390
368
  }
391
369
  //#endregion
392
370
  //#region src/Log.d.ts
393
- type Severity = 'DEFAULT' | 'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY';
394
- type Entry = {
395
- message?: string;
396
- severity: Severity;
397
- stack?: string;
398
- details?: unknown[];
371
+ type LogDetails = Record<string, unknown>;
372
+ type LogOptions = pino.LoggerOptions & {
373
+ environment?: string;
399
374
  };
375
+ /**
376
+ * Wrapper for [pino](https://github.com/pinojs/pino)
377
+ * Levels: fatal, error, warn, info, debug, trace
378
+ * Use `LOG_LEVL=info` to limit what's printed to console
379
+ * Use `Log.configure` to customize the pino instance
380
+ */
400
381
  declare class Log {
401
382
  #private;
402
- static getStack(): string[];
403
- /**
404
- * Handle first argument being a string or an object with a 'message' prop
405
- */
406
- static prepare(...input: unknown[]): {
407
- message?: string;
408
- details: unknown[];
409
- };
410
- /**
411
- * Events that require action or attention immediately
412
- */
413
- static alert(...input: unknown[]): Entry;
414
- /**
415
- * Events that cause problems
416
- */
417
- static error(...input: unknown[]): Entry;
418
- /**
419
- * Events that might cause problems
420
- */
421
- static warn(...input: unknown[]): Entry;
422
- /**
423
- * Normal but significant events, such as start up, shut down, or a configuration change
424
- */
425
- static notice(...input: unknown[]): Entry;
426
- /**
427
- * Routine information, such as ongoing status or performance
428
- */
429
- static info(...input: unknown[]): Entry;
430
- /**
431
- * Debug or trace information
432
- */
433
- static debug(...input: unknown[]): Entry;
383
+ static createLogger(): Logger;
384
+ static configure(options?: LogOptions): void;
385
+ static trace(message: string, details?: LogDetails): void;
386
+ static debug(message: string, details?: LogDetails): void;
387
+ static info(message: string, details?: LogDetails): void;
388
+ static warn(message: string, details?: LogDetails): void;
389
+ static error(message: string, details?: LogDetails): void;
390
+ static fatal(message: string, details?: LogDetails): void;
434
391
  }
435
392
  //#endregion
436
393
  //#region src/snapshot.d.ts
437
394
  /**
438
- * Allows special objects (Error, Headers, Set) to be included in JSON.stringify output.
439
- * Functions are removed
395
+ * @deprecated
396
+ * Allows special objects (Error, Headers, Set) to be included in JSON.stringify output. Functions are removed.
397
+ * ⚠️ This is bad! Only use it for debugging!
440
398
  */
441
399
  declare function snapshot(i: unknown, max?: number, depth?: number): any;
442
400
  //#endregion
443
401
  //#region src/timeout.d.ts
444
- declare function timeout(ms: number): Promise<unknown>;
402
+ declare function timeout(ms: number): Promise<void>;
445
403
  //#endregion
446
404
  //#region src/TypeWriter.d.ts
405
+ /**
406
+ * Wrapper for [quicktype-core](https://github.com/glideapps/quicktype)
407
+ * @example
408
+ * const group = new TypeWriter('Group');
409
+ * await types.addMember('Thing', [{ a: 1 }, { a: 2, b: 1 }]);
410
+ * await types.toFile();
411
+ * // type def for `Thing` saved in `types/Group.types.ts`
412
+ */
447
413
  declare class TypeWriter {
448
414
  moduleName: string;
449
415
  input: qt.JSONInput<string>;
450
416
  outDir: string;
451
417
  outFile: string;
452
- qtSettings: {
453
- lang: string;
454
- rendererOptions: {
455
- 'just-types': boolean;
456
- 'prefer-types': boolean;
457
- };
458
- inferEnums: boolean;
459
- inferDateTimes: boolean;
460
- } & {
461
- allPropertiesOptional?: boolean | undefined;
462
- alphabetizeProperties?: boolean | undefined;
463
- checkProvenance?: boolean | undefined;
464
- debugPrintGatherNames?: boolean | undefined;
465
- debugPrintGraph?: boolean | undefined;
466
- debugPrintReconstitution?: boolean | undefined;
467
- debugPrintSchemaResolving?: boolean | undefined;
468
- debugPrintTimes?: boolean | undefined;
469
- debugPrintTransformations?: boolean | undefined;
470
- fixedTopLevels?: boolean | undefined;
471
- indentation?: string | undefined;
472
- inputData?: qt.InputData | undefined;
473
- lang?: "cjson" | "cJSON" | "c++" | "cpp" | "cplusplus" | "crystal" | "cr" | "crystallang" | "cs" | "csharp" | "dart" | "elixir" | "elm" | "flow" | "go" | "golang" | "haskell" | "java" | "javascript" | "js" | "jsx" | "javascript-prop-types" | "schema" | "json-schema" | "kotlin" | "objc" | "objective-c" | "objectivec" | "php" | "pike" | "pikelang" | "python" | "py" | "ruby" | "rust" | "rs" | "rustlang" | "scala3" | "smithy4a" | "swift" | "swift4" | "typescript" | "ts" | "tsx" | "typescript-effect-schema" | "typescript-zod" | qt.TargetLanguage<quicktype_core_dist_TargetLanguage_js0.LanguageConfig> | undefined;
474
- leadingComments?: quicktype_core_dist_support_Comments_js0.Comment[] | undefined;
475
- noRender?: boolean | undefined;
476
- outputFilename?: string | undefined;
477
- rendererOptions?: qt.RendererOptions<"cjson" | "cJSON" | "c++" | "cpp" | "cplusplus" | "crystal" | "cr" | "crystallang" | "cs" | "csharp" | "dart" | "elixir" | "elm" | "flow" | "go" | "golang" | "haskell" | "java" | "javascript" | "js" | "jsx" | "javascript-prop-types" | "schema" | "json-schema" | "kotlin" | "objc" | "objective-c" | "objectivec" | "php" | "pike" | "pikelang" | "python" | "py" | "ruby" | "rust" | "rs" | "rustlang" | "scala3" | "smithy4a" | "swift" | "swift4" | "typescript" | "ts" | "tsx" | "typescript-effect-schema" | "typescript-zod", quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
478
- typeSourceStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"source-style", {
479
- readonly "single-source": true;
480
- readonly "multi-source": false;
481
- }, "single-source" | "multi-source">;
482
- typeIntegerSize: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"integer-size", {
483
- readonly int8_t: "int8_t";
484
- readonly int16_t: "int16_t";
485
- readonly int32_t: "int32_t";
486
- readonly int64_t: "int64_t";
487
- }, "int8_t" | "int16_t" | "int32_t" | "int64_t">;
488
- hashtableSize: quicktype_core_dist_RendererOptions_index_js0.StringOption<"hashtable-size">;
489
- addTypedefAlias: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"typedef-alias", {
490
- readonly "no-typedef": false;
491
- readonly "add-typedef": true;
492
- }, "no-typedef" | "add-typedef">;
493
- printStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"print-style", {
494
- readonly "print-formatted": false;
495
- readonly "print-unformatted": true;
496
- }, "print-formatted" | "print-unformatted">;
497
- typeNamingStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"type-style", {
498
- readonly "pascal-case": "pascal";
499
- readonly "underscore-case": "underscore";
500
- readonly "camel-case": "camel";
501
- readonly "upper-underscore-case": "upper-underscore";
502
- readonly "pascal-case-upper-acronyms": "pascal-upper-acronyms";
503
- readonly "camel-case-upper-acronyms": "camel-upper-acronyms";
504
- }, "pascal-case" | "underscore-case" | "camel-case" | "upper-underscore-case" | "pascal-case-upper-acronyms" | "camel-case-upper-acronyms">;
505
- memberNamingStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"member-style", {
506
- readonly "pascal-case": "pascal";
507
- readonly "underscore-case": "underscore";
508
- readonly "camel-case": "camel";
509
- readonly "upper-underscore-case": "upper-underscore";
510
- readonly "pascal-case-upper-acronyms": "pascal-upper-acronyms";
511
- readonly "camel-case-upper-acronyms": "camel-upper-acronyms";
512
- }, "pascal-case" | "underscore-case" | "camel-case" | "upper-underscore-case" | "pascal-case-upper-acronyms" | "camel-case-upper-acronyms">;
513
- enumeratorNamingStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"enumerator-style", {
514
- readonly "pascal-case": "pascal";
515
- readonly "underscore-case": "underscore";
516
- readonly "camel-case": "camel";
517
- readonly "upper-underscore-case": "upper-underscore";
518
- readonly "pascal-case-upper-acronyms": "pascal-upper-acronyms";
519
- readonly "camel-case-upper-acronyms": "camel-upper-acronyms";
520
- }, "pascal-case" | "underscore-case" | "camel-case" | "upper-underscore-case" | "pascal-case-upper-acronyms" | "camel-case-upper-acronyms">;
521
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
522
- typeSourceStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"source-style", {
523
- readonly "single-source": true;
524
- readonly "multi-source": false;
525
- }, "single-source" | "multi-source">;
526
- includeLocation: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"include-location", {
527
- readonly "local-include": true;
528
- readonly "global-include": false;
529
- }, "local-include" | "global-include">;
530
- codeFormat: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"code-format", {
531
- readonly "with-struct": false;
532
- readonly "with-getter-setter": true;
533
- }, "with-struct" | "with-getter-setter">;
534
- wstring: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"wstring", {
535
- readonly "use-string": false;
536
- readonly "use-wstring": true;
537
- }, "use-string" | "use-wstring">;
538
- westConst: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"const-style", {
539
- readonly "west-const": true;
540
- readonly "east-const": false;
541
- }, "west-const" | "east-const">;
542
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
543
- namespace: quicktype_core_dist_RendererOptions_index_js0.StringOption<"namespace">;
544
- enumType: quicktype_core_dist_RendererOptions_index_js0.StringOption<"enum-type">;
545
- typeNamingStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"type-style", {
546
- readonly "pascal-case": "pascal";
547
- readonly "underscore-case": "underscore";
548
- readonly "camel-case": "camel";
549
- readonly "upper-underscore-case": "upper-underscore";
550
- readonly "pascal-case-upper-acronyms": "pascal-upper-acronyms";
551
- readonly "camel-case-upper-acronyms": "camel-upper-acronyms";
552
- }, "pascal-case" | "underscore-case" | "camel-case" | "upper-underscore-case" | "pascal-case-upper-acronyms" | "camel-case-upper-acronyms">;
553
- memberNamingStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"member-style", {
554
- readonly "pascal-case": "pascal";
555
- readonly "underscore-case": "underscore";
556
- readonly "camel-case": "camel";
557
- readonly "upper-underscore-case": "upper-underscore";
558
- readonly "pascal-case-upper-acronyms": "pascal-upper-acronyms";
559
- readonly "camel-case-upper-acronyms": "camel-upper-acronyms";
560
- }, "pascal-case" | "underscore-case" | "camel-case" | "upper-underscore-case" | "pascal-case-upper-acronyms" | "camel-case-upper-acronyms">;
561
- enumeratorNamingStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"enumerator-style", {
562
- readonly "pascal-case": "pascal";
563
- readonly "underscore-case": "underscore";
564
- readonly "camel-case": "camel";
565
- readonly "upper-underscore-case": "upper-underscore";
566
- readonly "pascal-case-upper-acronyms": "pascal-upper-acronyms";
567
- readonly "camel-case-upper-acronyms": "camel-upper-acronyms";
568
- }, "pascal-case" | "underscore-case" | "camel-case" | "upper-underscore-case" | "pascal-case-upper-acronyms" | "camel-case-upper-acronyms">;
569
- boost: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"boost">;
570
- hideNullOptional: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"hide-null-optional">;
571
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{}> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
572
- readonly framework: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"framework", {
573
- readonly NewtonSoft: "NewtonSoft";
574
- readonly SystemTextJson: "SystemTextJson";
575
- }, "NewtonSoft" | "SystemTextJson">;
576
- readonly useList: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"array-type", {
577
- readonly array: false;
578
- readonly list: true;
579
- }, "array" | "list">;
580
- readonly dense: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"density", {
581
- readonly normal: false;
582
- readonly dense: true;
583
- }, "normal" | "dense">;
584
- readonly namespace: quicktype_core_dist_RendererOptions_index_js0.StringOption<"namespace">;
585
- readonly version: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"csharp-version", {
586
- readonly "5": 5;
587
- readonly "6": 6;
588
- }, "5" | "6">;
589
- readonly virtual: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"virtual">;
590
- readonly typeForAny: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"any-type", {
591
- readonly object: "object";
592
- readonly dynamic: "dynamic";
593
- }, "object" | "dynamic">;
594
- readonly useDecimal: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"number-type", {
595
- readonly double: false;
596
- readonly decimal: true;
597
- }, "decimal" | "double">;
598
- readonly features: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"features", {
599
- readonly complete: {
600
- readonly namespaces: true;
601
- readonly helpers: true;
602
- readonly attributes: true;
603
- };
604
- readonly "attributes-only": {
605
- readonly namespaces: true;
606
- readonly helpers: false;
607
- readonly attributes: true;
608
- };
609
- readonly "just-types-and-namespace": {
610
- readonly namespaces: true;
611
- readonly helpers: false;
612
- readonly attributes: false;
613
- };
614
- readonly "just-types": {
615
- readonly namespaces: true;
616
- readonly helpers: false;
617
- readonly attributes: false;
618
- };
619
- }, "complete" | "just-types" | "attributes-only" | "just-types-and-namespace">;
620
- readonly baseclass: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"base-class", {
621
- readonly EntityData: "EntityData";
622
- readonly Object: undefined;
623
- }, "EntityData" | "Object">;
624
- readonly checkRequired: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"check-required">;
625
- readonly keepPropertyName: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"keep-property-name">;
626
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
627
- nullSafety: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"null-safety">;
628
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
629
- codersInClass: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"coders-in-class">;
630
- methodNamesWithMap: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"from-map">;
631
- requiredProperties: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"required-props">;
632
- finalProperties: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"final-props">;
633
- generateCopyWith: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"copy-with">;
634
- useFreezed: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"use-freezed">;
635
- useHive: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"use-hive">;
636
- useJsonAnnotation: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"use-json-annotation">;
637
- partName: quicktype_core_dist_RendererOptions_index_js0.StringOption<"part-name">;
638
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
639
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
640
- namespace: quicktype_core_dist_RendererOptions_index_js0.StringOption<"namespace">;
641
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
642
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
643
- useList: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"array-type", {
644
- readonly array: false;
645
- readonly list: true;
646
- }, "array" | "list">;
647
- moduleName: quicktype_core_dist_RendererOptions_index_js0.StringOption<"module">;
648
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
649
- acronymStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"acronym-style", {
650
- readonly original: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Original;
651
- readonly pascal: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Pascal;
652
- readonly camel: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Camel;
653
- readonly lowerCase: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Lower;
654
- }, quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions>;
655
- runtimeTypecheck: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"runtime-typecheck">;
656
- runtimeTypecheckIgnoreUnknownProperties: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"runtime-typecheck-ignore-unknown-properties">;
657
- converters: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"converters", {
658
- readonly "top-level": quicktype_core_dist_support_Converters_js0.ConvertersOptions.TopLevel;
659
- readonly "all-objects": quicktype_core_dist_support_Converters_js0.ConvertersOptions.AllObjects;
660
- }, quicktype_core_dist_support_Converters_js0.ConvertersOptions>;
661
- rawType: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"raw-type", {
662
- readonly json: "json";
663
- readonly any: "any";
664
- }, "json" | "any">;
665
- } & {
666
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
667
- nicePropertyNames: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"nice-property-names">;
668
- declareUnions: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"explicit-unions">;
669
- preferUnions: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"prefer-unions">;
670
- preferTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"prefer-types">;
671
- preferConstValues: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"prefer-const-values">;
672
- readonly: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"readonly">;
673
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
674
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
675
- justTypesAndPackage: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types-and-package">;
676
- packageName: quicktype_core_dist_RendererOptions_index_js0.StringOption<"package">;
677
- multiFileOutput: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"multi-file-output">;
678
- fieldTags: quicktype_core_dist_RendererOptions_index_js0.StringOption<"field-tags">;
679
- omitEmpty: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"omit-empty">;
680
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
681
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
682
- useList: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"array-type", {
683
- readonly array: false;
684
- readonly list: true;
685
- }, "array" | "list">;
686
- moduleName: quicktype_core_dist_RendererOptions_index_js0.StringOption<"module">;
687
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
688
- useList: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"array-type", {
689
- readonly array: false;
690
- readonly list: true;
691
- }, "array" | "list">;
692
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
693
- dateTimeProvider: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"datetime-provider", {
694
- readonly java8: "java8";
695
- readonly legacy: "legacy";
696
- }, "java8" | "legacy">;
697
- acronymStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"acronym-style", {
698
- readonly original: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Original;
699
- readonly pascal: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Pascal;
700
- readonly camel: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Camel;
701
- readonly lowerCase: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Lower;
702
- }, quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions>;
703
- packageName: quicktype_core_dist_RendererOptions_index_js0.StringOption<"package">;
704
- lombok: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"lombok">;
705
- lombokCopyAnnotations: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"lombok-copy-annotations">;
706
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
707
- acronymStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"acronym-style", {
708
- readonly original: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Original;
709
- readonly pascal: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Pascal;
710
- readonly camel: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Camel;
711
- readonly lowerCase: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Lower;
712
- }, quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions>;
713
- runtimeTypecheck: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"runtime-typecheck">;
714
- runtimeTypecheckIgnoreUnknownProperties: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"runtime-typecheck-ignore-unknown-properties">;
715
- converters: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"converters", {
716
- readonly "top-level": quicktype_core_dist_support_Converters_js0.ConvertersOptions.TopLevel;
717
- readonly "all-objects": quicktype_core_dist_support_Converters_js0.ConvertersOptions.AllObjects;
718
- }, quicktype_core_dist_support_Converters_js0.ConvertersOptions>;
719
- rawType: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"raw-type", {
720
- readonly json: "json";
721
- readonly any: "any";
722
- }, "json" | "any">;
723
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
724
- acronymStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"acronym-style", {
725
- readonly original: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Original;
726
- readonly pascal: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Pascal;
727
- readonly camel: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Camel;
728
- readonly lowerCase: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Lower;
729
- }, quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions>;
730
- converters: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"converters", {
731
- readonly "top-level": quicktype_core_dist_support_Converters_js0.ConvertersOptions.TopLevel;
732
- readonly "all-objects": quicktype_core_dist_support_Converters_js0.ConvertersOptions.AllObjects;
733
- }, quicktype_core_dist_support_Converters_js0.ConvertersOptions>;
734
- moduleSystem: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"module-system", {
735
- readonly "common-js": false;
736
- readonly es6: true;
737
- }, "common-js" | "es6">;
738
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
739
- framework: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"framework", {
740
- readonly "just-types": "None";
741
- readonly jackson: "Jackson";
742
- readonly klaxon: "Klaxon";
743
- readonly kotlinx: "KotlinX";
744
- }, "just-types" | "jackson" | "klaxon" | "kotlinx">;
745
- acronymStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"acronym-style", {
746
- readonly original: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Original;
747
- readonly pascal: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Pascal;
748
- readonly camel: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Camel;
749
- readonly lowerCase: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Lower;
750
- }, quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions>;
751
- packageName: quicktype_core_dist_RendererOptions_index_js0.StringOption<"package">;
752
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
753
- features: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"features", {
754
- readonly all: {
755
- readonly interface: true;
756
- readonly implementation: true;
757
- };
758
- readonly interface: {
759
- readonly interface: true;
760
- readonly implementation: false;
761
- };
762
- readonly implementation: {
763
- readonly interface: false;
764
- readonly implementation: true;
765
- };
766
- }, "all" | "interface" | "implementation">;
767
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
768
- marshallingFunctions: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"functions">;
769
- classPrefix: quicktype_core_dist_RendererOptions_index_js0.StringOption<"class-prefix">;
770
- extraComments: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"extra-comments">;
771
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
772
- withGet: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"with-get">;
773
- fastGet: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"fast-get">;
774
- withSet: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"with-set">;
775
- withClosing: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"with-closing">;
776
- acronymStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"acronym-style", {
777
- readonly original: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Original;
778
- readonly pascal: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Pascal;
779
- readonly camel: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Camel;
780
- readonly lowerCase: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Lower;
781
- }, quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions>;
782
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
783
- features: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"python-version", {
784
- readonly "3.5": {
785
- readonly typeHints: false;
786
- readonly dataClasses: false;
787
- };
788
- readonly "3.6": {
789
- readonly typeHints: true;
790
- readonly dataClasses: false;
791
- };
792
- readonly "3.7": {
793
- readonly typeHints: true;
794
- readonly dataClasses: true;
795
- };
796
- }, "3.5" | "3.6" | "3.7">;
797
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
798
- nicePropertyNames: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"nice-property-names">;
799
- pydanticBaseModel: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"pydantic-base-model">;
800
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
801
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
802
- strictness: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"strictness", {
803
- readonly strict: quicktype_core_dist_language_Ruby_utils_js0.Strictness.Strict;
804
- readonly coercible: quicktype_core_dist_language_Ruby_utils_js0.Strictness.Coercible;
805
- readonly none: quicktype_core_dist_language_Ruby_utils_js0.Strictness.None;
806
- }, "none" | "strict" | "coercible">;
807
- namespace: quicktype_core_dist_RendererOptions_index_js0.StringOption<"namespace">;
808
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
809
- readonly density: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"density", {
810
- readonly normal: quicktype_core_dist_language_Rust_utils_js0.Density.Normal;
811
- readonly dense: quicktype_core_dist_language_Rust_utils_js0.Density.Dense;
812
- }, "normal" | "dense">;
813
- readonly visibility: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"visibility", {
814
- readonly private: quicktype_core_dist_language_Rust_utils_js0.Visibility.Private;
815
- readonly crate: quicktype_core_dist_language_Rust_utils_js0.Visibility.Crate;
816
- readonly public: quicktype_core_dist_language_Rust_utils_js0.Visibility.Public;
817
- }, "private" | "public" | "crate">;
818
- readonly deriveDebug: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"derive-debug">;
819
- readonly deriveClone: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"derive-clone">;
820
- readonly derivePartialEq: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"derive-partial-eq">;
821
- readonly skipSerializingNone: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"skip-serializing-none">;
822
- readonly edition2018: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"edition-2018">;
823
- readonly leadingComments: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"leading-comments">;
824
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
825
- framework: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"framework", {
826
- readonly "just-types": "None";
827
- readonly circe: "Circe";
828
- readonly upickle: "Upickle";
829
- }, "just-types" | "circe" | "upickle">;
830
- packageName: quicktype_core_dist_RendererOptions_index_js0.StringOption<"package">;
831
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
832
- framework: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"framework", {
833
- readonly "just-types": quicktype_core_dist_language_Smithy4s_language_js0.Framework;
834
- }, "just-types">;
835
- packageName: quicktype_core_dist_RendererOptions_index_js0.StringOption<"package">;
836
- }> | quicktype_core_dist_RendererOptions_types_js0.OptionMap<{
837
- justTypes: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"just-types">;
838
- convenienceInitializers: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"initializers">;
839
- explicitCodingKeys: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"coding-keys">;
840
- codingKeysProtocol: quicktype_core_dist_RendererOptions_index_js0.StringOption<"coding-keys-protocol">;
841
- alamofire: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"alamofire">;
842
- namedTypePrefix: quicktype_core_dist_RendererOptions_index_js0.StringOption<"type-prefix">;
843
- useClasses: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"struct-or-class", {
844
- readonly struct: false;
845
- readonly class: true;
846
- }, "class" | "struct">;
847
- mutableProperties: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"mutable-properties">;
848
- acronymStyle: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"acronym-style", {
849
- readonly original: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Original;
850
- readonly pascal: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Pascal;
851
- readonly camel: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Camel;
852
- readonly lowerCase: quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions.Lower;
853
- }, quicktype_core_dist_support_Acronyms_js0.AcronymStyleOptions>;
854
- dense: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"density", {
855
- readonly dense: true;
856
- readonly normal: false;
857
- }, "normal" | "dense">;
858
- linux: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"support-linux">;
859
- objcSupport: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"objective-c-support">;
860
- optionalEnums: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"optional-enums">;
861
- swift5Support: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"swift-5-support">;
862
- sendable: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"sendable">;
863
- multiFileOutput: quicktype_core_dist_RendererOptions_index_js0.BooleanOption<"multi-file-output">;
864
- accessLevel: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"access-level", {
865
- readonly internal: "internal";
866
- readonly public: "public";
867
- }, "internal" | "public">;
868
- protocol: quicktype_core_dist_RendererOptions_index_js0.EnumOption<"protocol", {
869
- readonly none: {
870
- readonly equatable: false;
871
- readonly hashable: false;
872
- };
873
- readonly equatable: {
874
- readonly equatable: true;
875
- readonly hashable: false;
876
- };
877
- readonly hashable: {
878
- readonly equatable: false;
879
- readonly hashable: true;
880
- };
881
- }, "none" | "equatable" | "hashable">;
882
- }>> | undefined;
883
- inferMaps?: boolean | undefined;
884
- inferEnums?: boolean | undefined;
885
- inferUuids?: boolean | undefined;
886
- inferDateTimes?: boolean | undefined;
887
- inferIntegerStrings?: boolean | undefined;
888
- inferBooleanStrings?: boolean | undefined;
889
- combineClasses?: boolean | undefined;
890
- ignoreJsonRefs?: boolean | undefined;
891
- };
418
+ qtSettings: Partial<qt.Options>;
892
419
  constructor(moduleName: string, settings?: {
893
420
  outDir?: string;
894
421
  outFile?: string;