yggio 0.0.14 → 0.0.16
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 +2 -3
- package/benchmarks/fix.js +24 -28
- package/benchmarks/types.js +0 -1
- package/binding.d.ts +225 -198
- package/binding.js +522 -812
- package/fields.js +43 -47
- package/index.d.ts +1541 -1051
- package/index.js +24 -18
- package/package.json +5 -5
- package/properties.js +13 -1
- package/records.js +83 -32
package/index.d.ts
CHANGED
|
@@ -6,8 +6,6 @@ export declare class Arn {
|
|
|
6
6
|
constructor(value: Arn | Uri | Url | Urn | string)
|
|
7
7
|
/** Infer an ARN from a native ARN/URI wrapper or string. */
|
|
8
8
|
static from(value: Arn | Uri | Url | Urn | string): Arn
|
|
9
|
-
/** Parse and validate an ARN. */
|
|
10
|
-
static fromString(value: string): Arn
|
|
11
9
|
/**
|
|
12
10
|
* Build a validated ARN from its five fields.
|
|
13
11
|
*
|
|
@@ -15,15 +13,35 @@ export declare class Arn {
|
|
|
15
13
|
* names neither.
|
|
16
14
|
*/
|
|
17
15
|
static fromParts(partition: string, service: string, region?: string | undefined | null, account?: string | undefined | null, resource?: string | undefined | null): Arn
|
|
16
|
+
/** The partition: `aws`, `aws-cn`, `aws-us-gov`, or another AWS names. */
|
|
17
|
+
get partition(): string
|
|
18
|
+
/** The service namespace: `s3`, `iam`, `lambda`, and the rest. */
|
|
19
|
+
get service(): string
|
|
20
|
+
/** The resource field whole, its own `/` and `:` structure kept. */
|
|
21
|
+
get resource(): string
|
|
22
|
+
/** The separator the resource field uses, if it carries one. */
|
|
23
|
+
get resourceSeparator(): string | null
|
|
24
|
+
/**
|
|
25
|
+
* The resource type, when the resource names one.
|
|
26
|
+
*
|
|
27
|
+
* This is the syntactic split at the resource's first `/` or `:`. What
|
|
28
|
+
* that leading part means is the service's own business - for Amazon S3 it
|
|
29
|
+
* is the bucket, which `bucket` is the door for.
|
|
30
|
+
*/
|
|
31
|
+
get resourceType(): string | null
|
|
32
|
+
/** What follows the type, or the whole resource when it names no type. */
|
|
33
|
+
get resourceId(): string
|
|
34
|
+
/** The table an Amazon S3 Tables ARN names, below its table bucket. */
|
|
35
|
+
get table(): string | null
|
|
36
|
+
/** Parse and validate an ARN. */
|
|
37
|
+
static fromString(value: string): Arn
|
|
18
38
|
/**
|
|
19
39
|
* Validate and convert any identifier, or URI text, into an ARN.
|
|
20
40
|
*
|
|
21
41
|
* The strict door, exactly as `Url.fromUri` is: what is not an ARN is
|
|
22
42
|
* refused in the core's own words rather than converted.
|
|
23
43
|
*/
|
|
24
|
-
static fromUri(value:
|
|
25
|
-
/** Deserialize the native structural JSON representation. */
|
|
26
|
-
static fromJSON(value: any): Arn
|
|
44
|
+
static fromUri(value: Uri | Url | Urn | Arn | string): Arn
|
|
27
45
|
/** The fixed lowercase `arn` scheme. */
|
|
28
46
|
get scheme(): string
|
|
29
47
|
/** ARN authority, which is canonically empty. */
|
|
@@ -64,28 +82,10 @@ export declare class Arn {
|
|
|
64
82
|
get length(): number
|
|
65
83
|
/** Return a path segment at an Array-compatible positive or negative index. */
|
|
66
84
|
at(index: number): string | null
|
|
67
|
-
/** The partition: `aws`, `aws-cn`, `aws-us-gov`, or another AWS names. */
|
|
68
|
-
get partition(): string
|
|
69
|
-
/** The service namespace: `s3`, `iam`, `lambda`, and the rest. */
|
|
70
|
-
get service(): string
|
|
71
85
|
/** The region, or `null` for a service that spans every region. */
|
|
72
86
|
get region(): string | null
|
|
73
87
|
/** The owning account, or `null` when the ARN names none. */
|
|
74
88
|
get account(): string | null
|
|
75
|
-
/** The resource field whole, its own `/` and `:` structure kept. */
|
|
76
|
-
get resource(): string
|
|
77
|
-
/** The separator the resource field uses, if it carries one. */
|
|
78
|
-
get resourceSeparator(): string | null
|
|
79
|
-
/**
|
|
80
|
-
* The resource type, when the resource names one.
|
|
81
|
-
*
|
|
82
|
-
* This is the syntactic split at the resource's first `/` or `:`. What
|
|
83
|
-
* that leading part means is the service's own business - for Amazon S3 it
|
|
84
|
-
* is the bucket, which `bucket` is the door for.
|
|
85
|
-
*/
|
|
86
|
-
get resourceType(): string | null
|
|
87
|
-
/** What follows the type, or the whole resource when it names no type. */
|
|
88
|
-
get resourceId(): string
|
|
89
89
|
/**
|
|
90
90
|
* The container an ARN names: the bucket on Amazon S3, the table bucket
|
|
91
91
|
* on Amazon S3 Tables.
|
|
@@ -93,8 +93,6 @@ export declare class Arn {
|
|
|
93
93
|
get bucket(): string | null
|
|
94
94
|
/** The object key an Amazon S3 ARN names, below its bucket. */
|
|
95
95
|
get key(): string | null
|
|
96
|
-
/** The table an Amazon S3 Tables ARN names, below its table bucket. */
|
|
97
|
-
get table(): string | null
|
|
98
96
|
/**
|
|
99
97
|
* The location this name addresses, as a `Url`.
|
|
100
98
|
*
|
|
@@ -107,6 +105,8 @@ export declare class Arn {
|
|
|
107
105
|
locator(): Url
|
|
108
106
|
/** Convert this ARN to its general URI representation. */
|
|
109
107
|
intoUri(): Uri
|
|
108
|
+
/** Deserialize the native structural JSON representation. */
|
|
109
|
+
static fromJSON(value: any): Arn
|
|
110
110
|
/** Exact normalized native equality. */
|
|
111
111
|
equals(other: Arn): boolean
|
|
112
112
|
/** Total native ordering: `-1`, `0`, or `1`. */
|
|
@@ -122,35 +122,6 @@ export declare class Arn {
|
|
|
122
122
|
}
|
|
123
123
|
export type JsArn = Arn
|
|
124
124
|
|
|
125
|
-
/**
|
|
126
|
-
* The cast from one field's layout to another, compiled once.
|
|
127
|
-
*
|
|
128
|
-
* Every failure the two fields alone can produce is raised by `compile`,
|
|
129
|
-
* before a row exists; `apply` then differs per column only in the rows it
|
|
130
|
-
* reads.
|
|
131
|
-
*/
|
|
132
|
-
export declare class ArrowCastPlan {
|
|
133
|
-
/**
|
|
134
|
-
* Run the compiled cast over no rows, refusing an impossible cast now
|
|
135
|
-
* rather than on the first column.
|
|
136
|
-
*/
|
|
137
|
-
preflight(): void
|
|
138
|
-
/**
|
|
139
|
-
* The field a column must lay out as: its storage and its extension
|
|
140
|
-
* identity.
|
|
141
|
-
*/
|
|
142
|
-
get source(): JsField
|
|
143
|
-
/** The field every cast lands under. */
|
|
144
|
-
get target(): JsField
|
|
145
|
-
/**
|
|
146
|
-
* Whether the plan hands every column of its source layout straight
|
|
147
|
-
* back.
|
|
148
|
-
*/
|
|
149
|
-
get isIdentity(): boolean
|
|
150
|
-
}
|
|
151
|
-
export type JsArrowCastPlan = ArrowCastPlan
|
|
152
|
-
|
|
153
|
-
|
|
154
125
|
/** One compressed block yielded by an owning lazy Avro iterator. */
|
|
155
126
|
export declare class AvroBlock {
|
|
156
127
|
/** Return the row count declared by the block header. */
|
|
@@ -341,6 +312,34 @@ export declare class ByteWriter {
|
|
|
341
312
|
}
|
|
342
313
|
export type JsFsByteWriter = ByteWriter
|
|
343
314
|
|
|
315
|
+
/**
|
|
316
|
+
* The cast from one field's layout to another, compiled once.
|
|
317
|
+
*
|
|
318
|
+
* Every failure the two fields alone can produce is raised by `compile`,
|
|
319
|
+
* before a row exists; `apply` then differs per column only in the rows it
|
|
320
|
+
* reads.
|
|
321
|
+
*/
|
|
322
|
+
export declare class CastPlan {
|
|
323
|
+
/**
|
|
324
|
+
* Run the compiled cast over no rows, refusing an impossible cast now
|
|
325
|
+
* rather than on the first column.
|
|
326
|
+
*/
|
|
327
|
+
preflight(): void
|
|
328
|
+
/**
|
|
329
|
+
* The field a column must lay out as: its storage and its extension
|
|
330
|
+
* identity.
|
|
331
|
+
*/
|
|
332
|
+
get source(): JsField
|
|
333
|
+
/** The field every cast lands under. */
|
|
334
|
+
get target(): JsField
|
|
335
|
+
/**
|
|
336
|
+
* Whether the plan hands every column of its source layout straight
|
|
337
|
+
* back.
|
|
338
|
+
*/
|
|
339
|
+
get isIdentity(): boolean
|
|
340
|
+
}
|
|
341
|
+
export type JsCastPlan = CastPlan
|
|
342
|
+
|
|
344
343
|
/**
|
|
345
344
|
* A warehouse catalog: the first namespace layer, what a warehouse registers
|
|
346
345
|
* by name.
|
|
@@ -480,9 +479,9 @@ export declare class Cell {
|
|
|
480
479
|
withError(error: string): Cell
|
|
481
480
|
/** This cell moved to `reference`. */
|
|
482
481
|
at(reference: CellRefInput): Cell
|
|
483
|
-
equals(other: Cell): boolean
|
|
484
482
|
clone(): Cell
|
|
485
483
|
toString(): string
|
|
484
|
+
equals(other: Cell): boolean
|
|
486
485
|
}
|
|
487
486
|
export type JsCell = Cell
|
|
488
487
|
|
|
@@ -516,11 +515,11 @@ export declare class CellRange {
|
|
|
516
515
|
containsRow(row: number): boolean
|
|
517
516
|
/** Whether the zero-based `column` lies inside the range. */
|
|
518
517
|
containsColumn(column: number): boolean
|
|
519
|
-
equals(other: CellRange): boolean
|
|
520
|
-
compare(other: CellRange): number
|
|
521
518
|
clone(): CellRange
|
|
522
519
|
toString(): string
|
|
523
520
|
toJSON(): string
|
|
521
|
+
equals(other: CellRange): boolean
|
|
522
|
+
compare(other: CellRange): number
|
|
524
523
|
}
|
|
525
524
|
export type JsCellRange = CellRange
|
|
526
525
|
|
|
@@ -544,11 +543,11 @@ export declare class CellRef {
|
|
|
544
543
|
* is not letters or lies past `XFD`.
|
|
545
544
|
*/
|
|
546
545
|
static columnIndex(letters: string): number | null
|
|
547
|
-
equals(other: CellRef): boolean
|
|
548
|
-
compare(other: CellRef): number
|
|
549
546
|
clone(): CellRef
|
|
550
547
|
toString(): string
|
|
551
548
|
toJSON(): string
|
|
549
|
+
equals(other: CellRef): boolean
|
|
550
|
+
compare(other: CellRef): number
|
|
552
551
|
}
|
|
553
552
|
export type JsCellRef = CellRef
|
|
554
553
|
|
|
@@ -604,8 +603,6 @@ export declare class ChunkedSerie {
|
|
|
604
603
|
* root. A record chunk holding an absent row is refused.
|
|
605
604
|
*/
|
|
606
605
|
intoArrowReader(): JsBatchReader
|
|
607
|
-
/** A copy sharing every chunk's buffers. */
|
|
608
|
-
clone(): ChunkedSerie
|
|
609
606
|
/**
|
|
610
607
|
* The first occurrence of every value across the chunks, with no
|
|
611
608
|
* join: each chunk filtered by its own first occurrences and kept
|
|
@@ -617,6 +614,8 @@ export declare class ChunkedSerie {
|
|
|
617
614
|
* apart.
|
|
618
615
|
*/
|
|
619
616
|
intoReversed(): ChunkedSerie
|
|
617
|
+
/** A copy sharing every chunk's buffers. */
|
|
618
|
+
clone(): ChunkedSerie
|
|
620
619
|
/** r" Whether no chunk holds a row. */
|
|
621
620
|
isEmpty(): boolean
|
|
622
621
|
/** r" Whether row `index` is absent. */
|
|
@@ -668,10 +667,7 @@ export declare class ChunkedSerie {
|
|
|
668
667
|
* r" where it declares none or is no record.
|
|
669
668
|
*/
|
|
670
669
|
declaredOrder(): Array<string> | null
|
|
671
|
-
|
|
672
|
-
intoStream(): JsStreamSerie
|
|
673
|
-
/** Moves these values into native chunks under optional row and byte bounds. */
|
|
674
|
-
intoChunkedStream(rowSize?: number | undefined | null, byteSize?: number | undefined | null): JsStreamChunkedSerie
|
|
670
|
+
|
|
675
671
|
}
|
|
676
672
|
export type JsChunkedSerie = ChunkedSerie
|
|
677
673
|
|
|
@@ -699,6 +695,29 @@ export declare class Compaction {
|
|
|
699
695
|
}
|
|
700
696
|
export type JsCompaction = Compaction
|
|
701
697
|
|
|
698
|
+
/**
|
|
699
|
+
* One session of an engine: its cursors, the transaction verbs and
|
|
700
|
+
* the table write, all on that session.
|
|
701
|
+
*/
|
|
702
|
+
export declare class Connection {
|
|
703
|
+
/** A new cursor: one statement on this session. */
|
|
704
|
+
cursor(): JsCursor
|
|
705
|
+
/**
|
|
706
|
+
* Publish the open transaction; none open is no work. The Yggio engine
|
|
707
|
+
* publishes each statement on its own.
|
|
708
|
+
*/
|
|
709
|
+
commit(): Promise<void>
|
|
710
|
+
/** Discard the open transaction; none open is no work. */
|
|
711
|
+
rollback(): Promise<void>
|
|
712
|
+
/**
|
|
713
|
+
* End the session: a remote one goes back to its engine's pool. A
|
|
714
|
+
* second close is no work, and every other call after it refuses by
|
|
715
|
+
* name.
|
|
716
|
+
*/
|
|
717
|
+
close(): Promise<void>
|
|
718
|
+
}
|
|
719
|
+
export type JsConnection = Connection
|
|
720
|
+
|
|
702
721
|
/**
|
|
703
722
|
* One ISO 3166-1 alpha-2 country code, held by its shape: at most two
|
|
704
723
|
* ASCII bytes, read as the `country` datatype reads one. Immutable.
|
|
@@ -727,6 +746,31 @@ export declare class Country {
|
|
|
727
746
|
}
|
|
728
747
|
export type JsCountry = Country
|
|
729
748
|
|
|
749
|
+
/**
|
|
750
|
+
* One statement on a session: it runs operations - SQL text read in the
|
|
751
|
+
* session's dialect, or a `Plan` - binds their parameters, and keeps the
|
|
752
|
+
* last result's rows, field and row count.
|
|
753
|
+
*/
|
|
754
|
+
export declare class Cursor {
|
|
755
|
+
/**
|
|
756
|
+
* The rows of the last statement as a `BatchReader`, once: each pull
|
|
757
|
+
* reads them from where they are, a remote engine's on the pool when
|
|
758
|
+
* iterated with `for await`.
|
|
759
|
+
*/
|
|
760
|
+
reader(): JsBatchReader
|
|
761
|
+
/**
|
|
762
|
+
* The last result's description: the root field its rows state, or
|
|
763
|
+
* `null` before a statement ran.
|
|
764
|
+
*/
|
|
765
|
+
get field(): JsField | null
|
|
766
|
+
/**
|
|
767
|
+
* The rows the last write wrote, where the engine counts them; `null`
|
|
768
|
+
* after a read.
|
|
769
|
+
*/
|
|
770
|
+
get rowCount(): number | null
|
|
771
|
+
}
|
|
772
|
+
export type JsCursor = Cursor
|
|
773
|
+
|
|
730
774
|
/**
|
|
731
775
|
* One live data file of the current snapshot, with the spec that placed it.
|
|
732
776
|
*
|
|
@@ -882,14 +926,6 @@ export declare class DataType {
|
|
|
882
926
|
static fromString(value: string): DataType
|
|
883
927
|
/** Build a Struct from named regex captures without reading data. */
|
|
884
928
|
static fromRegex(regex: string, autotype?: boolean | undefined | null): DataType
|
|
885
|
-
/**
|
|
886
|
-
* Deserialize the structural JSON representation.
|
|
887
|
-
*
|
|
888
|
-
* One entry point for the three shapes a caller already has: the document
|
|
889
|
-
* as a string, the same document as the bytes it was read from, or the
|
|
890
|
-
* object `JSON.parse` already turned it into.
|
|
891
|
-
*/
|
|
892
|
-
static fromJSON(value: any): DataType
|
|
893
929
|
/**
|
|
894
930
|
* Deserialize the structural JSON representation from bytes.
|
|
895
931
|
*
|
|
@@ -984,6 +1020,30 @@ export declare class DataType {
|
|
|
984
1020
|
* the type holding both, `false` at the tightest type naming both.
|
|
985
1021
|
*/
|
|
986
1022
|
mergeWith(other: DataType | string, upscale?: boolean | undefined | null): DataType
|
|
1023
|
+
/** Test for a child index, field name, or exact Field value. */
|
|
1024
|
+
contains(value: number | string | JsField): boolean
|
|
1025
|
+
/** Child names in physical order. */
|
|
1026
|
+
keys(): Array<string>
|
|
1027
|
+
/** Child fields in physical order. */
|
|
1028
|
+
values(): Array<JsField>
|
|
1029
|
+
/** Recursive native equality, optionally ignoring nested Field metadata. */
|
|
1030
|
+
equals(other: DataType, withMetadata?: boolean | undefined | null): boolean
|
|
1031
|
+
/**
|
|
1032
|
+
* Serialize to structural JSON bytes.
|
|
1033
|
+
*
|
|
1034
|
+
* The same document `toJSON` renders, encoded rather than decoded, for a
|
|
1035
|
+
* caller writing it straight to a file or a socket. `fromJSON` reads
|
|
1036
|
+
* these bytes back without being told which shape it got.
|
|
1037
|
+
*/
|
|
1038
|
+
toJSONBytes(): Buffer
|
|
1039
|
+
/**
|
|
1040
|
+
* Deserialize the structural JSON representation.
|
|
1041
|
+
*
|
|
1042
|
+
* One entry point for the three shapes a caller already has: the document
|
|
1043
|
+
* as a string, the same document as the bytes it was read from, or the
|
|
1044
|
+
* object `JSON.parse` already turned it into.
|
|
1045
|
+
*/
|
|
1046
|
+
static fromJSON(value: any): DataType
|
|
987
1047
|
/**
|
|
988
1048
|
* Every leaf under this node, named by its dotted path.
|
|
989
1049
|
*
|
|
@@ -1031,14 +1091,6 @@ export declare class DataType {
|
|
|
1031
1091
|
removeFieldByPath(path: string): JsField
|
|
1032
1092
|
/** Remove and return the child a position or a path names. */
|
|
1033
1093
|
removeField(key: number | string): JsField
|
|
1034
|
-
/** Test for a child index, field name, or exact Field value. */
|
|
1035
|
-
contains(value: number | string | JsField): boolean
|
|
1036
|
-
/** Child names in physical order. */
|
|
1037
|
-
keys(): Array<string>
|
|
1038
|
-
/** Child fields in physical order. */
|
|
1039
|
-
values(): Array<JsField>
|
|
1040
|
-
/** Recursive native equality, optionally ignoring nested Field metadata. */
|
|
1041
|
-
equals(other: DataType, withMetadata?: boolean | undefined | null): boolean
|
|
1042
1094
|
/** Join recursive differences, or return `✓ equal`. */
|
|
1043
1095
|
showDiff(other: DataType, withMetadata?: boolean | undefined | null, returnEqual?: boolean | undefined | null): string
|
|
1044
1096
|
/** Total native ordering: `-1`, `0`, or `1`. */
|
|
@@ -1051,14 +1103,6 @@ export declare class DataType {
|
|
|
1051
1103
|
toString(): string
|
|
1052
1104
|
/** Serialize to version-independent structural JSON. */
|
|
1053
1105
|
toJSON(): any
|
|
1054
|
-
/**
|
|
1055
|
-
* Serialize to structural JSON bytes.
|
|
1056
|
-
*
|
|
1057
|
-
* The same document `toJSON` renders, encoded rather than decoded, for a
|
|
1058
|
-
* caller writing it straight to a file or a socket. `fromJSON` reads
|
|
1059
|
-
* these bytes back without being told which shape it got.
|
|
1060
|
-
*/
|
|
1061
|
-
toJSONBytes(): Buffer
|
|
1062
1106
|
}
|
|
1063
1107
|
export type JsDataType = DataType
|
|
1064
1108
|
|
|
@@ -1193,12 +1237,12 @@ export declare class Expression {
|
|
|
1193
1237
|
explain(): string
|
|
1194
1238
|
/** Write this expression as a structural JSON document. */
|
|
1195
1239
|
intoJson(): string
|
|
1196
|
-
/** The canonical text, which re-parses to this expression. */
|
|
1197
|
-
toString(): string
|
|
1198
1240
|
/** Return whether two expressions are the same. */
|
|
1199
1241
|
equals(other: Expression | Plan | Selector | Filter | string): boolean
|
|
1200
1242
|
/** Compare two expressions by the core's total structural order. */
|
|
1201
1243
|
compare(other: Expression | Plan | Selector | Filter | string): number
|
|
1244
|
+
/** The canonical text, which re-parses to this expression. */
|
|
1245
|
+
toString(): string
|
|
1202
1246
|
/** Return deterministic hash bits for the canonical expression text. */
|
|
1203
1247
|
stableHash(): bigint
|
|
1204
1248
|
/** Make a cheap native clone of this immutable expression. */
|
|
@@ -1214,14 +1258,6 @@ export declare class Field {
|
|
|
1214
1258
|
static from(value: Field | string): Field
|
|
1215
1259
|
/** Parse canonical, Arrow, SQL, Hive, or Spark field syntax. */
|
|
1216
1260
|
static fromString(value: string): Field
|
|
1217
|
-
/**
|
|
1218
|
-
* Deserialize the structural JSON representation.
|
|
1219
|
-
*
|
|
1220
|
-
* One entry point for the three shapes a caller already has: the document
|
|
1221
|
-
* as a string, the same document as the bytes it was read from, or the
|
|
1222
|
-
* object `JSON.parse` already turned it into.
|
|
1223
|
-
*/
|
|
1224
|
-
static fromJSON(value: any): Field
|
|
1225
1261
|
/**
|
|
1226
1262
|
* Deserialize the structural JSON representation from bytes.
|
|
1227
1263
|
*
|
|
@@ -1243,28 +1279,8 @@ export declare class Field {
|
|
|
1243
1279
|
* carries over), and metadata (the union, this field winning a clash).
|
|
1244
1280
|
*/
|
|
1245
1281
|
mergeWith(other: Field, upscale?: boolean | undefined | null): Field
|
|
1246
|
-
/**
|
|
1247
|
-
* Every leaf under this node, named by its dotted path.
|
|
1248
|
-
*
|
|
1249
|
-
* Struct nesting flattens all the way down, and a leaf under a nullable
|
|
1250
|
-
* ancestor is nullable. Collections are leaves: a serie or a map is one
|
|
1251
|
-
* column, and `explodeFields` is what reaches inside one. Every name this
|
|
1252
|
-
* answers is one `fieldByPath` resolves.
|
|
1253
|
-
*/
|
|
1254
|
-
unnestFields(): Array<Field>
|
|
1255
|
-
/**
|
|
1256
|
-
* This node's children with every collection replaced by what it holds.
|
|
1257
|
-
*
|
|
1258
|
-
* A serie answers its item, a map its entries, a dictionary or run-end
|
|
1259
|
-
* node the values it encodes, and anything else itself - so the result
|
|
1260
|
-
* names the same columns in the same order. One level only, so the depth
|
|
1261
|
-
* is the caller's decision.
|
|
1262
|
-
*/
|
|
1263
|
-
explodeFields(): Array<Field>
|
|
1264
1282
|
/** Number of direct child fields. */
|
|
1265
1283
|
get fieldLen(): number
|
|
1266
|
-
/** Return the child at an Array-compatible index, or `null`. */
|
|
1267
|
-
getFieldAt(index: number): Field | null
|
|
1268
1284
|
/**
|
|
1269
1285
|
* Return where the child of one name sits, or `null`.
|
|
1270
1286
|
*
|
|
@@ -1272,33 +1288,6 @@ export declare class Field {
|
|
|
1272
1288
|
* at, which is what a caller reading a column out of a row needs.
|
|
1273
1289
|
*/
|
|
1274
1290
|
indexOf(name: string): number | null
|
|
1275
|
-
/**
|
|
1276
|
-
* Return the child a path names, or `null`.
|
|
1277
|
-
*
|
|
1278
|
-
* A child carrying the whole string wins before the string is decomposed
|
|
1279
|
-
* on `.`, so a name containing a dot stays reachable.
|
|
1280
|
-
*/
|
|
1281
|
-
getFieldByPath(path: string): Field | null
|
|
1282
|
-
/** Return the child a position or a path names, or `null`. */
|
|
1283
|
-
getField(key: number | string): Field | null
|
|
1284
|
-
/** Return the child at an Array-compatible index, or throw. */
|
|
1285
|
-
fieldAt(index: number): Field
|
|
1286
|
-
/** Return the child a path names, or throw. */
|
|
1287
|
-
fieldByPath(path: string): Field
|
|
1288
|
-
/** Return the child a position or a path names, or throw. */
|
|
1289
|
-
field(key: number | string): Field
|
|
1290
|
-
/** Replace the child at an Array-compatible index. */
|
|
1291
|
-
setFieldAt(index: number, child: Field): void
|
|
1292
|
-
/** Replace the child a path names, appending an unresolved name. */
|
|
1293
|
-
setFieldByPath(path: string, child: Field): void
|
|
1294
|
-
/** Replace the child a position or a path names. */
|
|
1295
|
-
setField(key: number | string, child: Field): void
|
|
1296
|
-
/** Remove and return the child at an Array-compatible index. */
|
|
1297
|
-
removeFieldAt(index: number): Field
|
|
1298
|
-
/** Remove and return the child a path names. */
|
|
1299
|
-
removeFieldByPath(path: string): Field
|
|
1300
|
-
/** Remove and return the child a position or a path names. */
|
|
1301
|
-
removeField(key: number | string): Field
|
|
1302
1291
|
/** Whether values may be null. */
|
|
1303
1292
|
get nullable(): boolean
|
|
1304
1293
|
/** Arrow IPC dictionary identifier, or `null` for non-dictionary fields. */
|
|
@@ -1335,7 +1324,7 @@ export declare class Field {
|
|
|
1335
1324
|
/**
|
|
1336
1325
|
* The enum this field's string values name, `null` when it declares none.
|
|
1337
1326
|
*
|
|
1338
|
-
* The declaration is one `
|
|
1327
|
+
* The declaration is one `enum` document, so it reaches Arrow, a
|
|
1339
1328
|
* file, and another runtime as ordinary field metadata and comes back the
|
|
1340
1329
|
* enum that was written.
|
|
1341
1330
|
*/
|
|
@@ -1398,6 +1387,19 @@ export declare class Field {
|
|
|
1398
1387
|
removeAlias(): string | null
|
|
1399
1388
|
/** Set the shared comment. */
|
|
1400
1389
|
setComment(value: string): void
|
|
1390
|
+
/**
|
|
1391
|
+
* What crosses when a same-width integer of the other signedness meets
|
|
1392
|
+
* this integer column: `'bits'` where the field's `representation` key
|
|
1393
|
+
* states them, `'value'` - the default - otherwise.
|
|
1394
|
+
*/
|
|
1395
|
+
get representation(): 'value' | 'bits'
|
|
1396
|
+
/**
|
|
1397
|
+
* State what crosses when a same-width integer of the other signedness
|
|
1398
|
+
* meets this integer column; `'value'` or `null` removes the
|
|
1399
|
+
* declaration, and `'bits'` on a column that is no integer is refused,
|
|
1400
|
+
* leaving the field unchanged.
|
|
1401
|
+
*/
|
|
1402
|
+
set representation(representation: 'value' | 'bits' | null)
|
|
1401
1403
|
/** Remove and return the shared comment. */
|
|
1402
1404
|
removeComment(): string | null
|
|
1403
1405
|
/** Set the shared display name. */
|
|
@@ -1547,13 +1549,6 @@ export declare class Field {
|
|
|
1547
1549
|
get iceberg(): JsProtocolField
|
|
1548
1550
|
/** The live Financial Information eXchange property view. */
|
|
1549
1551
|
get fix(): JsProtocolField
|
|
1550
|
-
/**
|
|
1551
|
-
* The live Yggio field property view.
|
|
1552
|
-
*
|
|
1553
|
-
* Named for the namespace it exposes rather than plain `field`, which on
|
|
1554
|
-
* a schema node reaches a nested child.
|
|
1555
|
-
*/
|
|
1556
|
-
get fieldProperties(): JsProtocolField
|
|
1557
1552
|
/** The live row-digest property view. */
|
|
1558
1553
|
get digest(): JsProtocolField
|
|
1559
1554
|
/** The live generic field-identity property view. */
|
|
@@ -1672,6 +1667,69 @@ export declare class Field {
|
|
|
1672
1667
|
clear(): void
|
|
1673
1668
|
/** Recursive native equality, optionally ignoring Field metadata. */
|
|
1674
1669
|
equals(other: Field, withMetadata?: boolean | undefined | null): boolean
|
|
1670
|
+
/**
|
|
1671
|
+
* Serialize to structural JSON bytes.
|
|
1672
|
+
*
|
|
1673
|
+
* The same document `toJSON` renders, encoded rather than decoded, for a
|
|
1674
|
+
* caller writing it straight to a file or a socket. `fromJSON` reads
|
|
1675
|
+
* these bytes back without being told which shape it got.
|
|
1676
|
+
*/
|
|
1677
|
+
toJSONBytes(): Buffer
|
|
1678
|
+
/**
|
|
1679
|
+
* Deserialize the structural JSON representation.
|
|
1680
|
+
*
|
|
1681
|
+
* One entry point for the three shapes a caller already has: the document
|
|
1682
|
+
* as a string, the same document as the bytes it was read from, or the
|
|
1683
|
+
* object `JSON.parse` already turned it into.
|
|
1684
|
+
*/
|
|
1685
|
+
static fromJSON(value: any): Field
|
|
1686
|
+
/**
|
|
1687
|
+
* Every leaf under this node, named by its dotted path.
|
|
1688
|
+
*
|
|
1689
|
+
* Struct nesting flattens all the way down, and a leaf under a nullable
|
|
1690
|
+
* ancestor is nullable. Collections are leaves: a serie or a map is one
|
|
1691
|
+
* column, and `explodeFields` is what reaches inside one. Every name this
|
|
1692
|
+
* answers is one `fieldByPath` resolves.
|
|
1693
|
+
*/
|
|
1694
|
+
unnestFields(): Array<Field>
|
|
1695
|
+
/**
|
|
1696
|
+
* This node's children with every collection replaced by what it holds.
|
|
1697
|
+
*
|
|
1698
|
+
* A serie answers its item, a map its entries, a dictionary or run-end
|
|
1699
|
+
* node the values it encodes, and anything else itself - so the result
|
|
1700
|
+
* names the same columns in the same order. One level only, so the depth
|
|
1701
|
+
* is the caller's decision.
|
|
1702
|
+
*/
|
|
1703
|
+
explodeFields(): Array<Field>
|
|
1704
|
+
/** Return the child at an Array-compatible index, or `null`. */
|
|
1705
|
+
getFieldAt(index: number): Field | null
|
|
1706
|
+
/**
|
|
1707
|
+
* Return the child a path names, or `null`.
|
|
1708
|
+
*
|
|
1709
|
+
* A child carrying the whole string wins before the string is decomposed
|
|
1710
|
+
* on `.`, so a name containing a dot stays reachable.
|
|
1711
|
+
*/
|
|
1712
|
+
getFieldByPath(path: string): Field | null
|
|
1713
|
+
/** Return the child a position or a path names, or `null`. */
|
|
1714
|
+
getField(key: number | string): Field | null
|
|
1715
|
+
/** Return the child at an Array-compatible index, or throw. */
|
|
1716
|
+
fieldAt(index: number): Field
|
|
1717
|
+
/** Return the child a path names, or throw. */
|
|
1718
|
+
fieldByPath(path: string): Field
|
|
1719
|
+
/** Return the child a position or a path names, or throw. */
|
|
1720
|
+
field(key: number | string): Field
|
|
1721
|
+
/** Replace the child at an Array-compatible index. */
|
|
1722
|
+
setFieldAt(index: number, child: Field): void
|
|
1723
|
+
/** Replace the child a path names, appending an unresolved name. */
|
|
1724
|
+
setFieldByPath(path: string, child: Field): void
|
|
1725
|
+
/** Replace the child a position or a path names. */
|
|
1726
|
+
setField(key: number | string, child: Field): void
|
|
1727
|
+
/** Remove and return the child at an Array-compatible index. */
|
|
1728
|
+
removeFieldAt(index: number): Field
|
|
1729
|
+
/** Remove and return the child a path names. */
|
|
1730
|
+
removeFieldByPath(path: string): Field
|
|
1731
|
+
/** Remove and return the child a position or a path names. */
|
|
1732
|
+
removeField(key: number | string): Field
|
|
1675
1733
|
/** Join recursive differences, or return `✓ equal`. */
|
|
1676
1734
|
showDiff(other: Field, withMetadata?: boolean | undefined | null, returnEqual?: boolean | undefined | null): string
|
|
1677
1735
|
/** Total native ordering: `-1`, `0`, or `1`. */
|
|
@@ -1684,14 +1742,6 @@ export declare class Field {
|
|
|
1684
1742
|
toString(): string
|
|
1685
1743
|
/** Serialize to version-independent structural JSON. */
|
|
1686
1744
|
toJSON(): any
|
|
1687
|
-
/**
|
|
1688
|
-
* Serialize to structural JSON bytes.
|
|
1689
|
-
*
|
|
1690
|
-
* The same document `toJSON` renders, encoded rather than decoded, for a
|
|
1691
|
-
* caller writing it straight to a file or a socket. `fromJSON` reads
|
|
1692
|
-
* these bytes back without being told which shape it got.
|
|
1693
|
-
*/
|
|
1694
|
-
toJSONBytes(): Buffer
|
|
1695
1745
|
}
|
|
1696
1746
|
export type JsField = Field
|
|
1697
1747
|
|
|
@@ -1813,12 +1863,12 @@ export declare class Filter {
|
|
|
1813
1863
|
explain(): string
|
|
1814
1864
|
/** Write this filter as a structural JSON document. */
|
|
1815
1865
|
intoJson(): string
|
|
1816
|
-
/** The canonical text, which re-parses to this filter. */
|
|
1817
|
-
toString(): string
|
|
1818
1866
|
/** Return whether two filters are the same predicate. */
|
|
1819
1867
|
equals(other: Filter | Term | string): boolean
|
|
1820
1868
|
/** Compare two filters by the core's total structural order. */
|
|
1821
1869
|
compare(other: Filter | Term | string): number
|
|
1870
|
+
/** The canonical text, which re-parses to this filter. */
|
|
1871
|
+
toString(): string
|
|
1822
1872
|
/** Return deterministic hash bits for the canonical filter text. */
|
|
1823
1873
|
stableHash(): bigint
|
|
1824
1874
|
/** Make a cheap native clone of this immutable filter. */
|
|
@@ -1826,304 +1876,6 @@ export declare class Filter {
|
|
|
1826
1876
|
}
|
|
1827
1877
|
export type JsFilter = Filter
|
|
1828
1878
|
|
|
1829
|
-
/**
|
|
1830
|
-
* One dictionary, reading captured lines into messages, with the Arrow twins.
|
|
1831
|
-
*
|
|
1832
|
-
* The codec is the whole parse surface: a captured line with a verb in front
|
|
1833
|
-
* of it, a bare frame, a numeric frame with a stated separator, a bridge's
|
|
1834
|
-
* name/value text, a configuration document, pairs a caller already split,
|
|
1835
|
-
* a record a text reader answered. Each redirects to the core method of the
|
|
1836
|
-
* same name, so nothing here decides a version or a separator - it only
|
|
1837
|
-
* carries what JavaScript said across. A stage is a call: the
|
|
1838
|
-
* stream methods take any iterable and answer a lazy `FixMessages`, the
|
|
1839
|
-
* Arrow methods take and answer a `BatchReader`, one batch at a time.
|
|
1840
|
-
*
|
|
1841
|
-
* Every message it builds is settled as it is parsed: the typed facts are
|
|
1842
|
-
* lifted off the line, a nested `XmlData` is exploded into the message,
|
|
1843
|
-
* deprecated fields are restated to their latest aliases, the dictionary's
|
|
1844
|
-
* native derivations run, the identifier maps and the security identifiers
|
|
1845
|
-
* fill, and
|
|
1846
|
-
* the identity is derived. `SendingTime` is the message's valid tag 52,
|
|
1847
|
-
* else a row cell reaching that tag, else the `mtime` of the `TextLine` it
|
|
1848
|
-
* was read out of - on `parseTextArrowReader`, the row's `transunix` cell -
|
|
1849
|
-
* else `defaultSendingTime`, else the Unix epoch, the same on every read,
|
|
1850
|
-
* and it goes back on the wire only when the message stated it: a clock
|
|
1851
|
-
* the parse supplied is never the message's own, so the row's `sendingtime`
|
|
1852
|
-
* column states none either. The raw-byte doors read no line, so parsing
|
|
1853
|
-
* undated bytes there without a default sending time is deliberately not
|
|
1854
|
-
* deterministic. A message reporting an execution that states no execution
|
|
1855
|
-
* clock executed at its instant: its `execunix` is its `transunix`.
|
|
1856
|
-
*/
|
|
1857
|
-
export declare class FixCodec {
|
|
1858
|
-
/**
|
|
1859
|
-
* Open a codec over one dictionary, or over the process default.
|
|
1860
|
-
*
|
|
1861
|
-
* Every pin is the core's, spelled once here. `separator` is the byte a
|
|
1862
|
-
* numeric frame splits on where
|
|
1863
|
-
* the line does not say; `payloadColumn` names the batch column a line
|
|
1864
|
-
* is read from; `captureNames` are what a run's row-header captures are
|
|
1865
|
-
* called, in the order a line answers them, which is what lets
|
|
1866
|
-
* `parseTextLine` read a capture by position rather than by name;
|
|
1867
|
-
* `nullValues` are the spellings that mean nothing was
|
|
1868
|
-
* sent; `direction` is the code of tag 385's set an unmarked line
|
|
1869
|
-
* takes on the batch door, any spelling of one - `"S"`, `"Send"`,
|
|
1870
|
-
* `"R"` - the core's `Send` code when unstated and no pin at all when
|
|
1871
|
-
* empty; `batchByteSize` and `batchRowSize` are the raw bytes and the
|
|
1872
|
-
* rows one Arrow batch targets, the core's 128 MiB and 65,536 rows when
|
|
1873
|
-
* unstated, whichever the batch reaches first; `threads` is how many
|
|
1874
|
-
* workers parsing and row conversion use, the available CPUs when
|
|
1875
|
-
* unstated. Arrow capture parsing keeps at most one input batch per
|
|
1876
|
-
* worker and yields in order; line doors use bounded row chunks.
|
|
1877
|
-
* One thread reads lazily without a pool; zero reads as one;
|
|
1878
|
-
* `includeMsgtypes` and
|
|
1879
|
-
* `excludeMsgtypes` are the message types a parse keeps and refuses,
|
|
1880
|
-
* each read before a frame is built and spelled as a code or a name -
|
|
1881
|
-
* `"0"`, `"Heartbeat"`, `"unknown"` for a line stating no type - the
|
|
1882
|
-
* core refusing `Heartbeat`, `TestRequest` and the untyped line when
|
|
1883
|
-
* unstated and an empty `excludeMsgtypes` keeping every type;
|
|
1884
|
-
* `defaultSendingTime` is the
|
|
1885
|
-
* `SendingTime` an undated message takes when nothing it was read with
|
|
1886
|
-
* dates it either, neither a capture reaching tag 52 nor the `mtime` of
|
|
1887
|
-
* the line it was read out of - a `Scalar` crosses as it is and must
|
|
1888
|
-
* already be `DateTime64(ns, UTC)`, a `Date` is its UTC millisecond
|
|
1889
|
-
* instant restated in nanoseconds, and `null` or absence reads the Unix epoch
|
|
1890
|
-
* per new message.
|
|
1891
|
-
* `snapshotNs` is an epoch-aligned lifecycle snapshot width in exact
|
|
1892
|
-
* nanoseconds; `null`, zero and a negative width disable snapshots;
|
|
1893
|
-
* `sortedLifecycle` states that the messages `lifecycle` is handed
|
|
1894
|
-
* arrive in instant order, so the walk reads them as they come one
|
|
1895
|
-
* epoch hour at a time rather than collecting and sorting the whole
|
|
1896
|
-
* capture, off when unstated;
|
|
1897
|
-
* `officialTimeDelayMs` is how far off a whole hour of its log line's
|
|
1898
|
-
* clock a stated clock may stand before it is `clock_skew` - the core's
|
|
1899
|
-
* half second when unstated - and dates nothing;
|
|
1900
|
-
* `marketMetadata` is whether a market operation carries its message's
|
|
1901
|
-
* unmapped fields - its parties, `Account(1)` and regulatory trade
|
|
1902
|
-
* identifiers stay its `partyids` and `identifiers` - and lifts the
|
|
1903
|
-
* identifiers among them into the set their type belongs to, on when
|
|
1904
|
-
* unstated; `source` is the id of the dictionary's source the codec
|
|
1905
|
-
* reads under, resolved once and refused when the catalog holds no
|
|
1906
|
-
* such id.
|
|
1907
|
-
*/
|
|
1908
|
-
constructor(registry?: FixRegistry | undefined | null, options?: FixCodecOptions | undefined | null)
|
|
1909
|
-
/**
|
|
1910
|
-
* A codec over the registry the process environment names,
|
|
1911
|
-
* `FixRegistry.fromEnv()`, pinned by the options the constructor takes.
|
|
1912
|
-
*/
|
|
1913
|
-
static fromEnv(options?: FixCodecOptions | undefined | null): FixCodec
|
|
1914
|
-
/** The dictionary this codec resolves against, sharing it. */
|
|
1915
|
-
get registry(): FixRegistry
|
|
1916
|
-
/** The byte a numeric frame splits on, or `null` where the line decides. */
|
|
1917
|
-
get separator(): number | null
|
|
1918
|
-
/** The record column a line is read from. */
|
|
1919
|
-
get payloadColumn(): string
|
|
1920
|
-
/** The spellings that mean nothing was sent. */
|
|
1921
|
-
get nullValues(): Array<string>
|
|
1922
|
-
/**
|
|
1923
|
-
* The code of tag 385's set an unmarked line takes on the batch door,
|
|
1924
|
-
* or `null` where no pin fills silence.
|
|
1925
|
-
*/
|
|
1926
|
-
get direction(): string | null
|
|
1927
|
-
/**
|
|
1928
|
-
* The source this codec reads under, folded: an entry of the
|
|
1929
|
-
* dictionary's sources catalog; `null` where none was named.
|
|
1930
|
-
*/
|
|
1931
|
-
get source(): string | null
|
|
1932
|
-
/**
|
|
1933
|
-
* This codec sharing `underlyings` across its parses and lifecycles
|
|
1934
|
-
* (`MarketMessagesOptions::with_underlyings`): a parse resolves each
|
|
1935
|
-
* message against it in stream order, creates the rows it names and
|
|
1936
|
-
* the table holds none of, and fills the message from them - its
|
|
1937
|
-
* `undcode` among them - so a search through the same table finds
|
|
1938
|
-
* what the parse wrote.
|
|
1939
|
-
*/
|
|
1940
|
-
withUnderlyings(underlyings: JsUnderlyings): FixCodec
|
|
1941
|
-
/**
|
|
1942
|
-
* The underlyings this codec resolves against, sharing them; `null`
|
|
1943
|
-
* where none was given and each walk starts from the seed.
|
|
1944
|
-
*/
|
|
1945
|
-
get underlyings(): JsUnderlyings | null
|
|
1946
|
-
/**
|
|
1947
|
-
* The raw bytes one Arrow batch targets.
|
|
1948
|
-
*
|
|
1949
|
-
* A byte count is a JavaScript number, exact to 2^53, as every count
|
|
1950
|
-
* at this boundary is.
|
|
1951
|
-
*/
|
|
1952
|
-
get batchByteSize(): number
|
|
1953
|
-
/** The rows one Arrow batch targets. */
|
|
1954
|
-
get batchRowSize(): number
|
|
1955
|
-
/** The workers parsing and row conversion use; available CPUs by default. */
|
|
1956
|
-
get threads(): number
|
|
1957
|
-
/**
|
|
1958
|
-
* The epoch-aligned lifecycle snapshot width in nanoseconds, or `null`
|
|
1959
|
-
* where snapshots are disabled.
|
|
1960
|
-
*/
|
|
1961
|
-
get snapshotNs(): bigint | null
|
|
1962
|
-
/**
|
|
1963
|
-
* This codec with its lifecycle snapshot grid set to `snapshotNs`, an
|
|
1964
|
-
* epoch-aligned width in exact nanoseconds: `null`, zero and a negative
|
|
1965
|
-
* width disable snapshots. Every other setting, the dictionary included,
|
|
1966
|
-
* is this codec's, so a caller's codec gains a grid without its options
|
|
1967
|
-
* being listed again.
|
|
1968
|
-
*/
|
|
1969
|
-
withSnapshotNs(snapshotNs: bigint | null): FixCodec
|
|
1970
|
-
/**
|
|
1971
|
-
* Whether `lifecycle` reads its messages as they come, in instant
|
|
1972
|
-
* order, one epoch hour at a time.
|
|
1973
|
-
*/
|
|
1974
|
-
get sortedLifecycle(): boolean
|
|
1975
|
-
/**
|
|
1976
|
-
* This codec with its lifecycle pinned to messages arriving in instant
|
|
1977
|
-
* order - a table read hour partition by hour partition, sorted by
|
|
1978
|
-
* `transunix` - when `sorted`: the walk then holds one epoch hour at a
|
|
1979
|
-
* time, sorts within it exactly as a whole capture is sorted, and walks
|
|
1980
|
-
* an hour once a message two hours past it is read; a message dated
|
|
1981
|
-
* before an hour already walked is walked where it arrives. `false`
|
|
1982
|
-
* collects and sorts the whole capture. Every other setting is this
|
|
1983
|
-
* codec's.
|
|
1984
|
-
*/
|
|
1985
|
-
withSortedLifecycle(sorted: boolean): FixCodec
|
|
1986
|
-
/**
|
|
1987
|
-
* How far off a whole hour of its log line's clock a stated clock may
|
|
1988
|
-
* stand before it is `clock_skew`, in milliseconds; it dates nothing.
|
|
1989
|
-
*
|
|
1990
|
-
* A millisecond count is a JavaScript number, exact to 2^53, as every
|
|
1991
|
-
* count at this boundary is.
|
|
1992
|
-
*/
|
|
1993
|
-
get officialTimeDelayMs(): number
|
|
1994
|
-
/**
|
|
1995
|
-
* The message types a parse keeps, empty where it keeps every type the
|
|
1996
|
-
* refusals leave.
|
|
1997
|
-
*/
|
|
1998
|
-
get includeMsgtypes(): Array<string>
|
|
1999
|
-
/** The message types a parse refuses before it builds a frame. */
|
|
2000
|
-
get excludeMsgtypes(): Array<string>
|
|
2001
|
-
/**
|
|
2002
|
-
* Whether a market operation this codec builds carries, in its
|
|
2003
|
-
* metadata, what its message states that no typed column reads and no
|
|
2004
|
-
* identifier map of the leaf holds, and lifts the identifiers among
|
|
2005
|
-
* them into the set their type belongs to.
|
|
2006
|
-
*/
|
|
2007
|
-
get marketMetadata(): boolean
|
|
2008
|
-
/**
|
|
2009
|
-
* The `SendingTime` an undated message takes - one neither its row nor
|
|
2010
|
-
* its line dates - `DateTime64(ns, UTC)`, or `null` where each new
|
|
2011
|
-
* undated message reads the Unix epoch.
|
|
2012
|
-
*/
|
|
2013
|
-
get defaultSendingTime(): JsScalar | null
|
|
2014
|
-
/** The complete raw message code declared by captured bytes. */
|
|
2015
|
-
static inferMsgtypeBytes(body: Buffer): Buffer | null
|
|
2016
|
-
/** The complete raw message code declared by captured text. */
|
|
2017
|
-
static inferMsgtypeText(body: string): string | null
|
|
2018
|
-
/** One captured line, whatever it is wrapped in: its messages. */
|
|
2019
|
-
parseLine(row: Buffer): FixMessages
|
|
2020
|
-
/** One numeric frame, read by the pairs it states. */
|
|
2021
|
-
parseFixLine(body: Buffer): MarketMessage
|
|
2022
|
-
/** One bridge frame, whose keys are names rather than tags. */
|
|
2023
|
-
parseUllinkLine(body: Buffer): MarketMessage
|
|
2024
|
-
/** One FIXML row, whose fields are XML attributes. */
|
|
2025
|
-
parseFixmlLine(body: Buffer): MarketMessage
|
|
2026
|
-
/** Pairs a caller already holds, in the order they arrived. */
|
|
2027
|
-
parsePairs(pairs: Array<[string, string]>): MarketMessage
|
|
2028
|
-
/**
|
|
2029
|
-
* One line a text reader answered: its messages.
|
|
2030
|
-
*
|
|
2031
|
-
* The line's body is the bytes read, and its row-header captures state
|
|
2032
|
-
* the rest - the plugin that logged it, the version, and every field a
|
|
2033
|
-
* capture's name reaches. A `timestamp` capture is context and stamps
|
|
2034
|
-
* nothing; the line's own clock does. Its `mtime` - an `mtime` capture,
|
|
2035
|
-
* else its handle's modification time - is the message's `techunix`,
|
|
2036
|
-
* and the sending clock of a message stating none: `SendingTime` is the
|
|
2037
|
-
* message's own, else a capture reaching that field, else the line's
|
|
2038
|
-
* `mtime`, else the codec's `defaultSendingTime`, else the Unix epoch, and the
|
|
2039
|
-
* instant `transunix` is the stated one, else the first plausible of
|
|
2040
|
-
* its evidence clocks, its stated `SendingTime` and its log line's
|
|
2041
|
-
* clock, within the codec's one-day skew bound of the log line.
|
|
2042
|
-
* A clock the parse supplied is never the message's own: neither the
|
|
2043
|
-
* wire nor the row's `sendingtime` column states it.
|
|
2044
|
-
* `withCaptureNames` is what decides which capture is which, once for
|
|
2045
|
-
* the whole run, because a line answers its captures by position.
|
|
2046
|
-
*
|
|
2047
|
-
* A `direction` capture is named so it cannot silently fill a field of
|
|
2048
|
-
* that name, and is not otherwise read: only `parseTextArrowReader` has
|
|
2049
|
-
* a column to put a direction in.
|
|
2050
|
-
*/
|
|
2051
|
-
parseTextLine(line: TextLine): FixMessages
|
|
2052
|
-
/**
|
|
2053
|
-
* A stream of Arrow batches of capture rows as batches of FIX rows.
|
|
2054
|
-
*
|
|
2055
|
-
* The schema is decided before the first row: the capture's own columns
|
|
2056
|
-
* lead and the fixed FIX columns follow. Every row is parsed as the
|
|
2057
|
-
* line door parses one - a row's `transunix` cell is its line's clock,
|
|
2058
|
-
* so it is the messages' `techunix` and the sending clock of one
|
|
2059
|
-
* stating none - and batches close on the bytes each row lands as
|
|
2060
|
-
* against `batchByteSize`. The source is consumed.
|
|
2061
|
-
*
|
|
2062
|
-
* The capture's own columns fill nothing: they are read off the source
|
|
2063
|
-
* row and written straight into the row this answers. This is the one door
|
|
2064
|
-
* that can state them, and it is why they survive a parse without a
|
|
2065
|
-
* message holding one.
|
|
2066
|
-
*/
|
|
2067
|
-
parseTextArrowReader(source: JsBatchReader): JsBatchReader
|
|
2068
|
-
/**
|
|
2069
|
-
* A stream of batches of FIX rows walked through one lifecycle.
|
|
2070
|
-
*
|
|
2071
|
-
* `lifecycle` over batches: each row is a message through
|
|
2072
|
-
* `MarketMessage.fromRow`, stated as the one after the live message it follows,
|
|
2073
|
-
* and written back under the **same** schema, so a carried column
|
|
2074
|
-
* returns to its place. Nothing is parsed again. The source is consumed.
|
|
2075
|
-
*
|
|
2076
|
-
* A carried column returns to its place because the message carries
|
|
2077
|
-
* it: each row's own cells are read into the message it made, under
|
|
2078
|
-
* their names, and stated again where that message lands. The pairing
|
|
2079
|
-
* is by message and never by position - a walk answers messages
|
|
2080
|
-
* in their own order, which a capture's lines are routinely not in.
|
|
2081
|
-
*/
|
|
2082
|
-
lifecycleArrowReader(source: JsBatchReader): JsBatchReader
|
|
2083
|
-
/**
|
|
2084
|
-
* A stream of batches of FIX rows as the stream of messages it holds.
|
|
2085
|
-
*
|
|
2086
|
-
* Each row is one message through `MarketMessage.fromRow` under the source's
|
|
2087
|
-
* schema, lazily, one batch held at a time: a batch
|
|
2088
|
-
* `parseTextArrowReader` wrote comes back as the messages that made it
|
|
2089
|
-
* without a parse. One half of what the Arrow twins compose;
|
|
2090
|
-
* `arrowReader` is the other. The source is consumed.
|
|
2091
|
-
*
|
|
2092
|
-
* The capture's own columns are carried: each row's own cells are read
|
|
2093
|
-
* into the message it makes, so `arrowReader(schema, messages(reader))`
|
|
2094
|
-
* states them again exactly as `lifecycleArrowReader(reader)` does.
|
|
2095
|
-
*/
|
|
2096
|
-
messages(source: JsBatchReader): FixMessages
|
|
2097
|
-
/**
|
|
2098
|
-
* A stream of batches of FIX rows as batches under one message field.
|
|
2099
|
-
*
|
|
2100
|
-
* The Arrow twin of `formatMessages`, and the last stage of the pipeline
|
|
2101
|
-
* a capture runs. Each row is read back as the message it holds and laid
|
|
2102
|
-
* under `field` by the one column rule, so a capture's own column
|
|
2103
|
-
* `field` names is stated from the cell each message carries. The
|
|
2104
|
-
* source is consumed.
|
|
2105
|
-
*/
|
|
2106
|
-
formatArrowReader(source: JsBatchReader, field: Field): JsBatchReader
|
|
2107
|
-
/**
|
|
2108
|
-
* Writes a stream of batches of FIX rows back to the wire, answering the
|
|
2109
|
-
* count of lines.
|
|
2110
|
-
*
|
|
2111
|
-
* The encode direction of the same exchange: each row is the message
|
|
2112
|
-
* `messages` reads out of it, written as `intoBytes` with the codec's
|
|
2113
|
-
* `separator` - `SOH` when none is pinned - then a newline, into `sink`,
|
|
2114
|
-
* anything with `write(chunk: Uint8Array)`. Each message renders what it
|
|
2115
|
-
* holds: the wire the row's `entries` restores, the facts' statements
|
|
2116
|
-
* at their places, and a message stating no `MsgType(35)` laid out by its
|
|
2117
|
-
* category. One batch is held at a time, and the source is consumed.
|
|
2118
|
-
*/
|
|
2119
|
-
writeArrowReader(source: BatchReader, sink: { write(chunk: Uint8Array): unknown }): number
|
|
2120
|
-
/** A cheap clone: the dictionary and the pins are shared. */
|
|
2121
|
-
clone(): FixCodec
|
|
2122
|
-
/** How this codec renders: the dictionary it reads against. */
|
|
2123
|
-
toString(): string
|
|
2124
|
-
}
|
|
2125
|
-
export type JsFixCodec = FixCodec
|
|
2126
|
-
|
|
2127
1879
|
/**
|
|
2128
1880
|
* The fields of a registry: the scalars in ascending identifier order, then
|
|
2129
1881
|
* the components and the groups.
|
|
@@ -2149,30 +1901,6 @@ export declare class FixFieldIterator {
|
|
|
2149
1901
|
}
|
|
2150
1902
|
export type JsFixFieldIterator = FixFieldIterator
|
|
2151
1903
|
|
|
2152
|
-
/**
|
|
2153
|
-
* A stream of messages, one at a time: the core's `MarketMessages`.
|
|
2154
|
-
*
|
|
2155
|
-
* Every stage of the codec answers one of these - one line's messages, a
|
|
2156
|
-
* stream of lines parsed, records parsed, messages walked, a batch read
|
|
2157
|
-
* back - so a message stream has one shape at this boundary whatever made
|
|
2158
|
-
* it. Nothing is collected: the core stream is the stream, and a
|
|
2159
|
-
* JavaScript iterable behind it is pulled one item at a time. What a
|
|
2160
|
-
* line or a message states that cannot stand is passed over with a warning
|
|
2161
|
-
* on standard error, never thrown; a failure in the iterable behind the
|
|
2162
|
-
* stream throws and ends it. The loader supplies `Symbol.iterator` over
|
|
2163
|
-
* `next`.
|
|
2164
|
-
*/
|
|
2165
|
-
export declare class FixMessages {
|
|
2166
|
-
/**
|
|
2167
|
-
* Advance the stream: the next message, or `null` at its end.
|
|
2168
|
-
*
|
|
2169
|
-
* A line the reader passed over is no item; a failure behind the stream
|
|
2170
|
-
* throws once, in place of the end.
|
|
2171
|
-
*/
|
|
2172
|
-
next(): IteratorResult<MarketMessage>
|
|
2173
|
-
}
|
|
2174
|
-
export type JsFixMessages = FixMessages
|
|
2175
|
-
|
|
2176
1904
|
/**
|
|
2177
1905
|
* FIX field definitions resolved by identifier, by tag, by name, or by dotted
|
|
2178
1906
|
* path.
|
|
@@ -2582,6 +2310,20 @@ export declare class FixRegistry {
|
|
|
2582
2310
|
* under a cursor into them. The loader wires `Symbol.iterator` over this.
|
|
2583
2311
|
*/
|
|
2584
2312
|
keys(): Generator<Field>
|
|
2313
|
+
/**
|
|
2314
|
+
* The plugin dictionary's rows (`FixPlugins::into_serie`): one `Serie`
|
|
2315
|
+
* under `fixPluginField()`, in id order - what a store keeps as
|
|
2316
|
+
* `plugins.json`. A copy: a later mutation of the registry leaves it
|
|
2317
|
+
* as it was answered.
|
|
2318
|
+
*/
|
|
2319
|
+
plugins(): JsSerie
|
|
2320
|
+
/**
|
|
2321
|
+
* The row of the plugin `code` names (`FixPlugins::rows_of`): its
|
|
2322
|
+
* name, an alias or its cross code (`plugincode`), as a one-row `Serie`
|
|
2323
|
+
* under `fixPluginField()`; `null` where the dictionary holds none. A
|
|
2324
|
+
* direct lookup, not a walk of `plugins()`.
|
|
2325
|
+
*/
|
|
2326
|
+
plugin(code: string): JsSerie | null
|
|
2585
2327
|
/** Whether two registries hold the same fields, in identifier order. */
|
|
2586
2328
|
equals(other: FixRegistry): boolean
|
|
2587
2329
|
/** Deterministic hash bits over all categories. */
|
|
@@ -2649,12 +2391,8 @@ export declare class Headers {
|
|
|
2649
2391
|
entries(): Array<[string, string]>
|
|
2650
2392
|
/** How many names are present. */
|
|
2651
2393
|
get length(): number
|
|
2652
|
-
/** Whether both maps hold the same names and values. */
|
|
2653
|
-
equals(other: Headers): boolean
|
|
2654
2394
|
/** The map as one plain object of lower-case names. */
|
|
2655
2395
|
toJSON(): Record<string, any>
|
|
2656
|
-
/** The map as the JSON object text it renders to. */
|
|
2657
|
-
toString(): string
|
|
2658
2396
|
/** `Content-Length`, in bytes. */
|
|
2659
2397
|
get contentLength(): number | null
|
|
2660
2398
|
/** `Content-Type`, as sent. */
|
|
@@ -2683,6 +2421,10 @@ export declare class Headers {
|
|
|
2683
2421
|
get nextLink(): string | null
|
|
2684
2422
|
/** Every `Set-Cookie` value, as sent. */
|
|
2685
2423
|
get setCookies(): Array<string>
|
|
2424
|
+
/** Whether both maps hold the same names and values. */
|
|
2425
|
+
equals(other: Headers): boolean
|
|
2426
|
+
/** The map as the JSON object text it renders to. */
|
|
2427
|
+
toString(): string
|
|
2686
2428
|
}
|
|
2687
2429
|
export type JsHeaders = Headers
|
|
2688
2430
|
|
|
@@ -3109,11 +2851,6 @@ export declare class IcebergTable {
|
|
|
3109
2851
|
* opened by its location alone stands under its folder's name.
|
|
3110
2852
|
*/
|
|
3111
2853
|
get path(): Array<string>
|
|
3112
|
-
/**
|
|
3113
|
-
* Whether both describe the same table: the path, the location, what
|
|
3114
|
-
* was stated - never what was read.
|
|
3115
|
-
*/
|
|
3116
|
-
equals(other: IcebergTable): boolean
|
|
3117
2854
|
/**
|
|
3118
2855
|
* The folder the table lives in.
|
|
3119
2856
|
*
|
|
@@ -3422,6 +3159,11 @@ export declare class IcebergTable {
|
|
|
3422
3159
|
* warehouse object prints.
|
|
3423
3160
|
*/
|
|
3424
3161
|
toString(): string
|
|
3162
|
+
/**
|
|
3163
|
+
* Whether both describe the same table: the path, the location, what
|
|
3164
|
+
* was stated - never what was read.
|
|
3165
|
+
*/
|
|
3166
|
+
equals(other: IcebergTable): boolean
|
|
3425
3167
|
}
|
|
3426
3168
|
export type JsTable = IcebergTable
|
|
3427
3169
|
|
|
@@ -3991,7 +3733,7 @@ export declare class IOBase {
|
|
|
3991
3733
|
*/
|
|
3992
3734
|
readArrowReader(options?: JsRecordOptions | undefined | null): JsBatchReader
|
|
3993
3735
|
/**
|
|
3994
|
-
* Read this resource's rows as a `
|
|
3736
|
+
* Read this resource's rows as a lazy `Serie`, one record serie per
|
|
3995
3737
|
* batch.
|
|
3996
3738
|
*
|
|
3997
3739
|
* Absent options are the handle's own: the encoding its media type
|
|
@@ -4135,6 +3877,12 @@ export type JsIOResult = IOResult
|
|
|
4135
3877
|
|
|
4136
3878
|
/** One immutable key context and its native payload. */
|
|
4137
3879
|
export declare class KeySerie {
|
|
3880
|
+
/** The key as a scalar record in key-field order. */
|
|
3881
|
+
get key(): JsScalar
|
|
3882
|
+
/** The absolute start of an adjacent window, absent for a partition or gather. */
|
|
3883
|
+
get rownum(): number | null
|
|
3884
|
+
/** The context and payload as separate native values. */
|
|
3885
|
+
intoParts(): [JsScalar, JsSerie]
|
|
4138
3886
|
/** The complete field: key columns followed by payload columns. */
|
|
4139
3887
|
get field(): Field
|
|
4140
3888
|
/** The field of the explicit key context. */
|
|
@@ -4143,23 +3891,23 @@ export declare class KeySerie {
|
|
|
4143
3891
|
get serieField(): Field
|
|
4144
3892
|
/** Source paths for moved columns; computed and external keys have no path. */
|
|
4145
3893
|
get keyPaths(): Array<JsFieldPath | undefined | null>
|
|
4146
|
-
/** The key as a scalar record in key-field order. */
|
|
4147
|
-
get key(): JsScalar
|
|
4148
|
-
/** The absolute start of an adjacent window, absent for a partition or gather. */
|
|
4149
|
-
get rownum(): number | null
|
|
4150
|
-
/** The context and payload as separate native values. */
|
|
4151
|
-
intoParts(): [JsScalar, JsSerie]
|
|
4152
3894
|
/** The bytes currently held, without pulling a stream. */
|
|
4153
3895
|
memorySize(): number
|
|
4154
|
-
/** Moves these values into a native scalar-row stream. */
|
|
4155
|
-
intoStream(): StreamSerie
|
|
4156
|
-
/** Moves these values into native chunks under optional row and byte bounds. */
|
|
4157
|
-
intoChunkedStream(rowSize?: number | undefined | null, byteSize?: number | undefined | null): JsStreamChunkedSerie
|
|
4158
3896
|
}
|
|
4159
3897
|
export type JsKeySerie = KeySerie
|
|
4160
3898
|
|
|
4161
3899
|
/** A repeatable collection of native key items sharing one layout. */
|
|
4162
3900
|
export declare class KeySeries {
|
|
3901
|
+
/**
|
|
3902
|
+
* The number of key items; a lazy collection is drained once, and its
|
|
3903
|
+
* stream's failure throws.
|
|
3904
|
+
*/
|
|
3905
|
+
get length(): number
|
|
3906
|
+
/**
|
|
3907
|
+
* The item at this position, absent outside the collection; a lazy
|
|
3908
|
+
* collection's stream failure throws.
|
|
3909
|
+
*/
|
|
3910
|
+
get(index: number): KeySerie | null
|
|
4163
3911
|
/** The complete field: key columns followed by payload columns. */
|
|
4164
3912
|
get field(): Field
|
|
4165
3913
|
/** The field of the explicit key context. */
|
|
@@ -4168,16 +3916,8 @@ export declare class KeySeries {
|
|
|
4168
3916
|
get serieField(): Field
|
|
4169
3917
|
/** Source paths for moved columns; computed and external keys have no path. */
|
|
4170
3918
|
get keyPaths(): Array<JsFieldPath | undefined | null>
|
|
4171
|
-
/** The number of held key items. */
|
|
4172
|
-
get length(): number
|
|
4173
|
-
/** The held item at this position, absent outside the collection. */
|
|
4174
|
-
get(index: number): KeySerie | null
|
|
4175
3919
|
/** The bytes currently held, without pulling a stream. */
|
|
4176
3920
|
memorySize(): number
|
|
4177
|
-
/** Moves these values into a native scalar-row stream. */
|
|
4178
|
-
intoStream(): StreamSerie
|
|
4179
|
-
/** Moves these values into native chunks under optional row and byte bounds. */
|
|
4180
|
-
intoChunkedStream(rowSize?: number | undefined | null, byteSize?: number | undefined | null): JsStreamChunkedSerie
|
|
4181
3921
|
}
|
|
4182
3922
|
export type JsKeySeries = KeySeries
|
|
4183
3923
|
|
|
@@ -4329,7 +4069,8 @@ export type JsManifestFile = ManifestFile
|
|
|
4329
4069
|
export declare class MarketMessage {
|
|
4330
4070
|
/**
|
|
4331
4071
|
* A FIX record - a struct root and its row - read as the parse reads
|
|
4332
|
-
* one, under `
|
|
4072
|
+
* one, under `options`, `MarketMessagesOptions.fromEnv()` when none
|
|
4073
|
+
* are given.
|
|
4333
4074
|
*
|
|
4334
4075
|
* The loader widens `value`: anything `Scalar.fromJs` reads becomes the
|
|
4335
4076
|
* native value first, and the core alone validates and canonicalizes it
|
|
@@ -4345,23 +4086,74 @@ export declare class MarketMessage {
|
|
|
4345
4086
|
* no execution clock that instant too. What `OrigSendingTime(122)` says
|
|
4346
4087
|
* is the lifecycle's to read. The identity is then settled.
|
|
4347
4088
|
*/
|
|
4348
|
-
static fromFixRecord(field: Field, value: JsScalar,
|
|
4089
|
+
static fromFixRecord(field: Field, value: JsScalar, options?: JsMarketMessagesOptions | undefined | null): MarketMessage
|
|
4349
4090
|
/**
|
|
4350
4091
|
* The message a row holds: the inverse of `intoRow`.
|
|
4351
4092
|
*
|
|
4352
4093
|
* `schema` is the row's root - the message row `MarketMessage.field()`
|
|
4353
4094
|
* lays out, or a batch reader's `field` - and `row` the row under it,
|
|
4354
4095
|
* which the loader widens from whatever `Scalar.fromJs` reads. The row
|
|
4355
|
-
* is one row of `
|
|
4096
|
+
* is one row of `MarketMessages.fromArrowReader`: each column binds as a lookup
|
|
4356
4097
|
* binds its name - a fact, a statement, an entry - the content is
|
|
4357
4098
|
* rebuilt from the `entries` column, each entry typed through the
|
|
4358
4099
|
* dictionary exactly
|
|
4359
4100
|
* as the parse types a pair, so `intoBytes` re-emits the line the row
|
|
4360
4101
|
* was read from, and every column nothing binds is carried under its
|
|
4361
4102
|
* name, as `carried` answers. Nothing is parsed again and no clock is
|
|
4362
|
-
* read. The
|
|
4103
|
+
* read. The row is read under `options`,
|
|
4104
|
+
* `MarketMessagesOptions.fromEnv()` when none are given.
|
|
4105
|
+
*/
|
|
4106
|
+
static fromRow(schema: Field, row: JsScalar, options?: JsMarketMessagesOptions | undefined | null): MarketMessage
|
|
4107
|
+
/**
|
|
4108
|
+
* The one message a captured line states, whatever it is wrapped in -
|
|
4109
|
+
* its format sniffed - under `options`, `MarketMessagesOptions.fromEnv()`
|
|
4110
|
+
* when none are given. A line stating no message, and a line carrying
|
|
4111
|
+
* a second frame, throws: `MarketMessages.fromLines` reads a line's
|
|
4112
|
+
* every message.
|
|
4363
4113
|
*/
|
|
4364
|
-
static
|
|
4114
|
+
static fromLine(row: Buffer, options?: JsMarketMessagesOptions | undefined | null): MarketMessage
|
|
4115
|
+
/**
|
|
4116
|
+
* The one message a line a text reader answered states, under
|
|
4117
|
+
* `options`, `MarketMessagesOptions.fromEnv()` when none are given.
|
|
4118
|
+
*
|
|
4119
|
+
* The line's body is the bytes read, and its row-header captures state
|
|
4120
|
+
* the rest - the plugin that logged it, the version, and every field a
|
|
4121
|
+
* capture's name reaches. A `timestamp` capture is context and stamps
|
|
4122
|
+
* nothing; the line's own clock does. Its `mtime` - an `mtime` capture,
|
|
4123
|
+
* else its handle's modification time - is the message's `technicaltimestamp`,
|
|
4124
|
+
* and the sending clock of a message stating none: `SendingTime` is the
|
|
4125
|
+
* message's own, else a capture reaching that field, else the line's
|
|
4126
|
+
* `mtime`, else the options' `defaultSendingTime`, else the Unix epoch,
|
|
4127
|
+
* and the instant `markettimestamp` is the stated one, else the first
|
|
4128
|
+
* plausible of its evidence clocks, its stated `SendingTime` and its log
|
|
4129
|
+
* line's clock, within the one-day skew bound of the log line. A clock
|
|
4130
|
+
* the parse supplied is never the message's own: neither the wire nor
|
|
4131
|
+
* the row's `sendingtime` column states it. The options' `captureNames`
|
|
4132
|
+
* decide which capture is which, once for the whole run, because a
|
|
4133
|
+
* line answers its captures by position. A line carrying a second
|
|
4134
|
+
* frame throws.
|
|
4135
|
+
*/
|
|
4136
|
+
static fromTextLine(line: TextLine, options?: MarketMessagesOptions | undefined | null): MarketMessage
|
|
4137
|
+
/**
|
|
4138
|
+
* One numeric FIX frame, read by the pairs it states, under `options`,
|
|
4139
|
+
* `MarketMessagesOptions.fromEnv()` when none are given.
|
|
4140
|
+
*/
|
|
4141
|
+
static fromFixMessage(body: Buffer, options?: JsMarketMessagesOptions | undefined | null): MarketMessage
|
|
4142
|
+
/**
|
|
4143
|
+
* One bridge frame, whose keys are names rather than tags, under
|
|
4144
|
+
* `options`, `MarketMessagesOptions.fromEnv()` when none are given.
|
|
4145
|
+
*/
|
|
4146
|
+
static fromUllinkLine(body: Buffer, options?: JsMarketMessagesOptions | undefined | null): MarketMessage
|
|
4147
|
+
/**
|
|
4148
|
+
* One FIXML message, whose fields are XML attributes, under `options`,
|
|
4149
|
+
* `MarketMessagesOptions.fromEnv()` when none are given.
|
|
4150
|
+
*/
|
|
4151
|
+
static fromFixmlMessage(body: Buffer, options?: JsMarketMessagesOptions | undefined | null): MarketMessage
|
|
4152
|
+
/**
|
|
4153
|
+
* Pairs a caller already holds, in the order they arrived, under
|
|
4154
|
+
* `options`, `MarketMessagesOptions.fromEnv()` when none are given.
|
|
4155
|
+
*/
|
|
4156
|
+
static fromPairs(pairs: Array<[string, string]>, options?: MarketMessagesOptions | undefined | null): MarketMessage
|
|
4365
4157
|
/**
|
|
4366
4158
|
* The one message row, `fixmsg`: the element, event, market,
|
|
4367
4159
|
* operation, source and session columns, the two holders
|
|
@@ -4446,7 +4238,7 @@ export declare class MarketMessage {
|
|
|
4446
4238
|
* When the operation the message states happened - its transaction
|
|
4447
4239
|
* instant: nanoseconds since the Unix epoch, UTC.
|
|
4448
4240
|
*/
|
|
4449
|
-
get
|
|
4241
|
+
get markettimestamp(): bigint
|
|
4450
4242
|
/**
|
|
4451
4243
|
* The order state the message reached, ranked: `UNKNOWN` where it
|
|
4452
4244
|
* states none.
|
|
@@ -4458,11 +4250,11 @@ export declare class MarketMessage {
|
|
|
4458
4250
|
* instant between, one more for each next; once walked, the place its
|
|
4459
4251
|
* content took there.
|
|
4460
4252
|
*/
|
|
4461
|
-
get
|
|
4253
|
+
get sequencenumber(): number
|
|
4462
4254
|
/** The identity of the message this one follows, or `null`. */
|
|
4463
|
-
get
|
|
4255
|
+
get previousuuid(): string | null
|
|
4464
4256
|
/** When the order this message belongs to was created, where known. */
|
|
4465
|
-
get
|
|
4257
|
+
get creationtimestamp(): bigint | null
|
|
4466
4258
|
/**
|
|
4467
4259
|
* The digits after the second `TransactTime(60)` was stated with - 0,
|
|
4468
4260
|
* 3, 6 or 9 - the row's `clockprecision`; `null` where it states none.
|
|
@@ -4489,28 +4281,28 @@ export declare class MarketMessage {
|
|
|
4489
4281
|
/** The earliest `LastTrade` stamp. */
|
|
4490
4282
|
get lasttradetime(): bigint | null
|
|
4491
4283
|
/** The latest execution instant the lifecycle reached, where known. */
|
|
4492
|
-
get
|
|
4284
|
+
get lastexecutiontimestamp(): bigint | null
|
|
4493
4285
|
/**
|
|
4494
4286
|
* When the message crossed the wire - its carrier's clock, else its
|
|
4495
4287
|
* stated `SendingTime` - where stated.
|
|
4496
4288
|
*/
|
|
4497
|
-
get
|
|
4289
|
+
get technicaltimestamp(): bigint | null
|
|
4498
4290
|
/** When the order expires, where it has an expiry. */
|
|
4499
|
-
get
|
|
4291
|
+
get expirytimestamp(): bigint | null
|
|
4500
4292
|
/** When the message this one follows happened, where it follows one. */
|
|
4501
|
-
get
|
|
4293
|
+
get previousmarkettimestamp(): bigint | null
|
|
4502
4294
|
/**
|
|
4503
4295
|
* The grid step a walk read this message as the snapshot of, where one
|
|
4504
4296
|
* did.
|
|
4505
4297
|
*/
|
|
4506
|
-
get
|
|
4298
|
+
get snapshottimestamp(): bigint | null
|
|
4507
4299
|
/**
|
|
4508
4300
|
* The sorted unique identities of the elements this one was read from:
|
|
4509
4301
|
* the text line it was parsed out of, and for a message split off
|
|
4510
4302
|
* another that message's identity beside its sources; none for one
|
|
4511
4303
|
* parsed from raw bytes. Provenance, never its chain: no walk moves it.
|
|
4512
4304
|
*/
|
|
4513
|
-
get
|
|
4305
|
+
get sourceuuids(): Array<string>
|
|
4514
4306
|
/**
|
|
4515
4307
|
* The capture's own cells the message carries, each under the column
|
|
4516
4308
|
* it was read from: where the line was read from, its place in the
|
|
@@ -4553,7 +4345,7 @@ export declare class MarketMessage {
|
|
|
4553
4345
|
* The currency the bid is stated in: a stated `BidCurrency`, else the
|
|
4554
4346
|
* message's currency where it states a bid; `null` otherwise.
|
|
4555
4347
|
*/
|
|
4556
|
-
get
|
|
4348
|
+
get bidcurrency(): string | null
|
|
4557
4349
|
/**
|
|
4558
4350
|
* The offer price the message states, `OfferPx(133)`, as decimal text, or
|
|
4559
4351
|
* `null`.
|
|
@@ -4569,7 +4361,7 @@ export declare class MarketMessage {
|
|
|
4569
4361
|
* `OfferCurrency`, else the message's currency where it states an offer;
|
|
4570
4362
|
* `null` otherwise.
|
|
4571
4363
|
*/
|
|
4572
|
-
get
|
|
4364
|
+
get offercurrency(): string | null
|
|
4573
4365
|
/**
|
|
4574
4366
|
* The names the operation goes by, each typed by the field that
|
|
4575
4367
|
* stated it - `orderid`, `clordid`, `execid`, `quoteid`, `tradeid` and
|
|
@@ -4624,15 +4416,15 @@ export declare class MarketMessage {
|
|
|
4624
4416
|
get currency(): string
|
|
4625
4417
|
/**
|
|
4626
4418
|
* The currency the product originates in, as the `ccy` code it is:
|
|
4627
|
-
* the crate field `
|
|
4419
|
+
* the crate field `origincurrency` the message states, or what a registry
|
|
4628
4420
|
* filled; `null` where neither did, never defaulted.
|
|
4629
4421
|
*/
|
|
4630
|
-
get
|
|
4422
|
+
get origincurrency(): string | null
|
|
4631
4423
|
/**
|
|
4632
|
-
* The origin currency read with its default: `
|
|
4424
|
+
* The origin currency read with its default: `origincurrency` where held,
|
|
4633
4425
|
* else `currency` - `XXX` only where neither is stated.
|
|
4634
4426
|
*/
|
|
4635
|
-
get
|
|
4427
|
+
get originOrCurrency(): string
|
|
4636
4428
|
/**
|
|
4637
4429
|
* The price the message last traded at, as decimal text, or `null`.
|
|
4638
4430
|
* FIX's own `LastPx(31)`.
|
|
@@ -4658,9 +4450,9 @@ export declare class MarketMessage {
|
|
|
4658
4450
|
* The price stated before this message - its own closing price, else
|
|
4659
4451
|
* what the statement it follows settled on, which a walk fills.
|
|
4660
4452
|
*/
|
|
4661
|
-
get
|
|
4453
|
+
get previousprice(): string | null
|
|
4662
4454
|
/** The quantity that statement settled on, or `null`. */
|
|
4663
|
-
get
|
|
4455
|
+
get previousquantity(): string | null
|
|
4664
4456
|
/** The spot part of an FX forward price, as decimal text, or `null`. */
|
|
4665
4457
|
get lastspotrate(): string | null
|
|
4666
4458
|
/**
|
|
@@ -4806,13 +4598,27 @@ export declare class MarketMessage {
|
|
|
4806
4598
|
* nothing at a column answers null there rather than shifting its
|
|
4807
4599
|
* neighbours; `entries` closes the row with the entries no other
|
|
4808
4600
|
* column holds, and the capture's own columns state the cells the
|
|
4809
|
-
* message carries. The row is the one `
|
|
4601
|
+
* message carries. The row is the one `MarketMessages.intoSerie` lays.
|
|
4810
4602
|
*
|
|
4811
4603
|
* A value a column will not hold is that column's null and stays in
|
|
4812
4604
|
* `entries`; a column that cannot be null and that nothing binds
|
|
4813
4605
|
* throws, naming it. No clock is read.
|
|
4814
4606
|
*/
|
|
4815
4607
|
intoRow(schema: Field): JsScalar
|
|
4608
|
+
/**
|
|
4609
|
+
* Where each value this message holds came from, as rows under the
|
|
4610
|
+
* explanation row - `fact`, `source`, `rule`, `from`, `note` - in the
|
|
4611
|
+
* row's column order, computed on demand off what the message holds:
|
|
4612
|
+
* its `markettimestamp` beside the clock that dated it; every fact and its
|
|
4613
|
+
* metadata whose source is not unset - stated, a FIX derivation or
|
|
4614
|
+
* default by the tag the fact binds (`der.<tag>`, `def.<tag>`), a fill
|
|
4615
|
+
* by the underlying row or the rates, a carry from its previous
|
|
4616
|
+
* statement, an implication, a plugin version's stamp - each by the
|
|
4617
|
+
* rule id that filled it; every entry by its origin; then every
|
|
4618
|
+
* anomaly, its reason as the note. A message read back off its row
|
|
4619
|
+
* explains each fact its `factsources` names as the live message did.
|
|
4620
|
+
*/
|
|
4621
|
+
explain(): JsSerie
|
|
4816
4622
|
/**
|
|
4817
4623
|
* Re-emit this message on the wire, separated by `separator`: the
|
|
4818
4624
|
* header, the facts' statements and the entries, each at its place,
|
|
@@ -4847,6 +4653,312 @@ export declare class MarketMessage {
|
|
|
4847
4653
|
}
|
|
4848
4654
|
export type JsMarketMessage = MarketMessage
|
|
4849
4655
|
|
|
4656
|
+
/**
|
|
4657
|
+
* A handler over a stream of messages: the core's `MarketMessages`.
|
|
4658
|
+
*
|
|
4659
|
+
* `new MarketMessages(options?)` is the idle handler: the options it reads
|
|
4660
|
+
* under - `options`, else `MarketMessagesOptions.fromEnv()` - over no
|
|
4661
|
+
* stream. A source answers a new handler over its stream and leaves this
|
|
4662
|
+
* one idle, so one handler opens many: `fromLines`, `fromTextLines`,
|
|
4663
|
+
* `fromItems`, `fromArrowReader`, `fromTextArrowReader`. A stage answers
|
|
4664
|
+
* the handler over what it makes of the stream - `intoLifecycle`,
|
|
4665
|
+
* `intoLineage` - and a sink drains it - `intoArrowReader`, `intoSerie`,
|
|
4666
|
+
* `intoWriter`; each takes the stream once, and a second take throws
|
|
4667
|
+
* naming the first. Nothing is collected unless a stage says so: the core
|
|
4668
|
+
* stream is the stream, and a JavaScript iterable behind it is pulled one
|
|
4669
|
+
* item at a time. What a line or a message states that cannot stand is
|
|
4670
|
+
* passed over with a warning on standard error, never thrown; a failure
|
|
4671
|
+
* of the iterable behind a source ends the stream after the messages
|
|
4672
|
+
* before it, and `next` throws it as itself. The loader supplies
|
|
4673
|
+
* `Symbol.iterator` over `next`.
|
|
4674
|
+
*/
|
|
4675
|
+
export declare class MarketMessages {
|
|
4676
|
+
/**
|
|
4677
|
+
* An idle handler over `options`, else over
|
|
4678
|
+
* `MarketMessagesOptions.fromEnv()`: what every source opens from.
|
|
4679
|
+
*/
|
|
4680
|
+
constructor(options?: JsMarketMessagesOptions | undefined | null)
|
|
4681
|
+
/**
|
|
4682
|
+
* The messages a stream of batches of rows holds, lazily, one batch
|
|
4683
|
+
* held at a time: the rows landed under `field`, else under the
|
|
4684
|
+
* reader's own root, each row one message rebuilt with no line parsed
|
|
4685
|
+
* again - its own cells carried, so a column no fact, statement or
|
|
4686
|
+
* entry reads travels with the message it made and a sink states it
|
|
4687
|
+
* again at its place. The source is consumed.
|
|
4688
|
+
*/
|
|
4689
|
+
fromArrowReader(source: JsBatchReader, field?: Field | undefined | null): MarketMessages
|
|
4690
|
+
/**
|
|
4691
|
+
* The messages a stream of batches of capture rows states: each row
|
|
4692
|
+
* read as a line, its body the payload column and its `markettimestamp`
|
|
4693
|
+
* cell the line's clock - the messages' `technicaltimestamp` and the sending
|
|
4694
|
+
* clock of one stating none - and the capture's own columns carried
|
|
4695
|
+
* beside the fixed FIX columns, so a sink states them again. The
|
|
4696
|
+
* source is consumed.
|
|
4697
|
+
*/
|
|
4698
|
+
fromTextArrowReader(source: JsBatchReader): MarketMessages
|
|
4699
|
+
/**
|
|
4700
|
+
* The one walk over events, as a stage: the messages collected and
|
|
4701
|
+
* sorted by instant - read as they come, one epoch hour held at a
|
|
4702
|
+
* time, where the options' `sortedLifecycle` states they arrive in
|
|
4703
|
+
* instant order - every one but a batch container and the session
|
|
4704
|
+
* administration stated through `withPrevious` as the one after the
|
|
4705
|
+
* version its chain - its market data kind and cross hash code -
|
|
4706
|
+
* holds, carrying the predecessor's `previousuuid`, `previousmarkettimestamp` and
|
|
4707
|
+
* `previousstate`, and yielded only where its content code or state moved:
|
|
4708
|
+
* a copy folds into the held version. A message no held version
|
|
4709
|
+
* precedes is answered as it came. One whose sending clock the parse
|
|
4710
|
+
* supplied rather than read is dated by the `TransactTime(60)` it
|
|
4711
|
+
* states. Takes the stream.
|
|
4712
|
+
*/
|
|
4713
|
+
intoLifecycle(): MarketMessages
|
|
4714
|
+
/**
|
|
4715
|
+
* The path each event took, as a stage: the observations grouped by
|
|
4716
|
+
* event - `msgeventkey`, else the observation's own `crossuuid` - and
|
|
4717
|
+
* ordered by `technicaltimestamp`, else `markettimestamp`, then stream order; one hop
|
|
4718
|
+
* per observation, a message row whose `lastplugincode` is the node it
|
|
4719
|
+
* came from, `plugincode` the node it reached, `previousuuid` the hop
|
|
4720
|
+
* before it, `sequencenumber` its index and `crossuuid` the event. A node is
|
|
4721
|
+
* the observation's plugin, else its session, else its
|
|
4722
|
+
* `SenderCompID`; a plain FIX message is `SenderCompID` to
|
|
4723
|
+
* `TargetCompID`. Collects the stream. Takes the stream.
|
|
4724
|
+
*/
|
|
4725
|
+
intoLineage(): MarketMessages
|
|
4726
|
+
/**
|
|
4727
|
+
* The stream as batches of rows under `field`, else under the stream's
|
|
4728
|
+
* own root: each message one row, every column read by its fact, its
|
|
4729
|
+
* tag or its name, batches closing on the options' `batchRowSize`
|
|
4730
|
+
* rows or `batchByteSize` laid bytes, whichever a batch reaches first.
|
|
4731
|
+
* A failure behind the stream is the reader's error, thrown by the
|
|
4732
|
+
* batch it would have landed in. Takes the stream.
|
|
4733
|
+
*/
|
|
4734
|
+
intoArrowReader(field?: Field | undefined | null): JsBatchReader
|
|
4735
|
+
/**
|
|
4736
|
+
* The stream's messages as rows, as a `Serie` read lazily: with no
|
|
4737
|
+
* `field`, each message one row of the stream's own root; with one -
|
|
4738
|
+
* a venue's own message type, `MarketMessage.field()`, any Struct root
|
|
4739
|
+
* a caller built - each laid under it by the one column rule, so a
|
|
4740
|
+
* column the message does not state is null. A message a row will
|
|
4741
|
+
* not hold is passed over with a warning. Takes the stream.
|
|
4742
|
+
*/
|
|
4743
|
+
intoSerie(field?: Field | undefined | null): JsSerie
|
|
4744
|
+
/**
|
|
4745
|
+
* Writes each message back to the wire into `sink` - anything with
|
|
4746
|
+
* `write(chunk: Uint8Array)` - one per line: `intoBytes` with the
|
|
4747
|
+
* options' `separator`, `SOH` when none is pinned, then a newline.
|
|
4748
|
+
* Each message renders what it holds: the wire a row's `entries`
|
|
4749
|
+
* restores, the facts' statements at their places, and a message
|
|
4750
|
+
* stating no `MsgType(35)` laid out by its category. Answers the count
|
|
4751
|
+
* of lines. One message is held at a time. Takes the stream.
|
|
4752
|
+
*/
|
|
4753
|
+
intoWriter(sink: { write(chunk: Uint8Array): unknown }): number
|
|
4754
|
+
/** The options every message is read under, shared. */
|
|
4755
|
+
get options(): JsMarketMessagesOptions
|
|
4756
|
+
/**
|
|
4757
|
+
* Advance the stream: the next message, or `null` at its end.
|
|
4758
|
+
*
|
|
4759
|
+
* A line the reader passed over is no item; a failure behind the
|
|
4760
|
+
* stream throws once, in place of the end. A stream a stage or a sink
|
|
4761
|
+
* took throws naming it.
|
|
4762
|
+
*/
|
|
4763
|
+
next(): IteratorResult<MarketMessage>
|
|
4764
|
+
}
|
|
4765
|
+
export type JsMarketMessages = MarketMessages
|
|
4766
|
+
|
|
4767
|
+
/**
|
|
4768
|
+
* The options a market message stream reads under: one dictionary and
|
|
4769
|
+
* every pin a parse, a walk and a sink read - the core's
|
|
4770
|
+
* `MarketMessagesOptions`, shared.
|
|
4771
|
+
*
|
|
4772
|
+
* Options hold no stream: `new MarketMessages(options)` is the handler that
|
|
4773
|
+
* reads under them, and the one-message parses are `MarketMessage` statics
|
|
4774
|
+
* taking them - `fromLine`, `fromTextLine`, `fromFixMessage`,
|
|
4775
|
+
* `fromUllinkLine`, `fromFixmlMessage`, `fromPairs`. Nothing here decides a
|
|
4776
|
+
* version or a separator - it only carries what JavaScript said across.
|
|
4777
|
+
*
|
|
4778
|
+
* Every message read under them is settled as it is parsed: the typed
|
|
4779
|
+
* facts are lifted off the line, a nested `XmlData` is exploded into the
|
|
4780
|
+
* message, deprecated fields are restated to their latest aliases, the
|
|
4781
|
+
* dictionary's native derivations run, the identifier maps and the
|
|
4782
|
+
* security identifiers fill, and the identity is derived. `SendingTime` is
|
|
4783
|
+
* the message's valid tag 52, else a row cell reaching that tag, else the
|
|
4784
|
+
* `mtime` of the `TextLine` it was read out of - on
|
|
4785
|
+
* `MarketMessages.fromTextArrowReader`, the row's `markettimestamp` cell - else
|
|
4786
|
+
* `defaultSendingTime`, else the Unix epoch, the same on every read, and it
|
|
4787
|
+
* goes back on the wire only when the message stated it: a clock the parse
|
|
4788
|
+
* supplied is never the message's own, so the row's `sendingtime` column
|
|
4789
|
+
* states none either. The raw-byte doors read no line, so parsing undated
|
|
4790
|
+
* bytes there without a default sending time is deliberately not
|
|
4791
|
+
* deterministic. A message reporting an execution that states no execution
|
|
4792
|
+
* clock executed at its instant: its `lastexecutiontimestamp` is its `markettimestamp`.
|
|
4793
|
+
*/
|
|
4794
|
+
export declare class MarketMessagesOptions {
|
|
4795
|
+
/**
|
|
4796
|
+
* The options over one dictionary, or over the process default.
|
|
4797
|
+
*
|
|
4798
|
+
* Every pin is the core's, spelled once here. `separator` is the byte a
|
|
4799
|
+
* numeric frame splits on where
|
|
4800
|
+
* the line does not say; `payloadColumn` names the batch column a line
|
|
4801
|
+
* is read from; `captureNames` are what a run's row-header captures are
|
|
4802
|
+
* called, in the order a line answers them, which is what lets
|
|
4803
|
+
* `MarketMessage.fromTextLine` read a capture by position rather than by name;
|
|
4804
|
+
* `nullValues` are the spellings that mean nothing was
|
|
4805
|
+
* sent; `direction` is the code of tag 385's set an unmarked line
|
|
4806
|
+
* takes on the batch door, any spelling of one - `"S"`, `"Send"`,
|
|
4807
|
+
* `"R"` - the core's `Send` code when unstated and no pin at all when
|
|
4808
|
+
* empty; `batchByteSize` and `batchRowSize` are the raw bytes and the
|
|
4809
|
+
* rows one Arrow batch targets, the core's 128 MiB and 65,536 rows when
|
|
4810
|
+
* unstated, whichever the batch reaches first; `threads` is how many
|
|
4811
|
+
* workers parsing and row conversion use, the available CPUs when
|
|
4812
|
+
* unstated. Arrow capture parsing keeps at most one input batch per
|
|
4813
|
+
* worker and yields in order; line doors use bounded row chunks.
|
|
4814
|
+
* One thread reads lazily without a pool; zero reads as one;
|
|
4815
|
+
* `includeMsgtypes` and
|
|
4816
|
+
* `excludeMsgtypes` are the message types a parse keeps and refuses,
|
|
4817
|
+
* each read before a frame is built and spelled as a code or a name -
|
|
4818
|
+
* `"0"`, `"Heartbeat"`, `"unknown"` for a line stating no type - the
|
|
4819
|
+
* core refusing `Heartbeat`, `TestRequest` and the untyped line when
|
|
4820
|
+
* unstated and an empty `excludeMsgtypes` keeping every type;
|
|
4821
|
+
* `defaultSendingTime` is the
|
|
4822
|
+
* `SendingTime` an undated message takes when nothing it was read with
|
|
4823
|
+
* dates it either, neither a capture reaching tag 52 nor the `mtime` of
|
|
4824
|
+
* the line it was read out of - a `Scalar` crosses as it is and must
|
|
4825
|
+
* already be `DateTime64(ns, UTC)`, a `Date` is its UTC millisecond
|
|
4826
|
+
* instant restated in nanoseconds, and `null` or absence reads the Unix epoch
|
|
4827
|
+
* per new message.
|
|
4828
|
+
* `snapshotNs` is an epoch-aligned lifecycle snapshot width in exact
|
|
4829
|
+
* nanoseconds; `null`, zero and a negative width disable snapshots;
|
|
4830
|
+
* `sortedLifecycle` states that the messages `intoLifecycle` walks
|
|
4831
|
+
* arrive in instant order, so the walk reads them as they come one
|
|
4832
|
+
* epoch hour at a time rather than collecting and sorting the whole
|
|
4833
|
+
* capture, off when unstated;
|
|
4834
|
+
* `officialTimeDelayMs` is how far off a whole hour of its log line's
|
|
4835
|
+
* clock a stated clock may stand before it is `clock_skew` - the core's
|
|
4836
|
+
* half second when unstated - and dates nothing;
|
|
4837
|
+
* `marketMetadata` is whether a market operation carries its message's
|
|
4838
|
+
* unmapped fields - its parties, `Account(1)` and regulatory trade
|
|
4839
|
+
* identifiers stay its `partyids` and `identifiers` - and lifts the
|
|
4840
|
+
* identifiers among them into the set their type belongs to, on when
|
|
4841
|
+
* unstated; `source` is the id of the dictionary's source the options
|
|
4842
|
+
* read under, resolved once and refused when the catalog holds no
|
|
4843
|
+
* such id.
|
|
4844
|
+
*/
|
|
4845
|
+
constructor(registry?: FixRegistry | undefined | null, options?: MarketMessagesOptionsInit | undefined | null)
|
|
4846
|
+
/**
|
|
4847
|
+
* The options over the registry the process environment names,
|
|
4848
|
+
* `FixRegistry.fromEnv()`, pinned by the init the constructor takes.
|
|
4849
|
+
*/
|
|
4850
|
+
static fromEnv(options?: MarketMessagesOptionsInit | undefined | null): MarketMessagesOptions
|
|
4851
|
+
/** The dictionary these options resolve against, sharing it. */
|
|
4852
|
+
get registry(): FixRegistry
|
|
4853
|
+
/** The byte a numeric frame splits on, or `null` where the line decides. */
|
|
4854
|
+
get separator(): number | null
|
|
4855
|
+
/** The record column a line is read from. */
|
|
4856
|
+
get payloadColumn(): string
|
|
4857
|
+
/** The spellings that mean nothing was sent. */
|
|
4858
|
+
get nullValues(): Array<string>
|
|
4859
|
+
/**
|
|
4860
|
+
* The code of tag 385's set an unmarked line takes on the batch door,
|
|
4861
|
+
* or `null` where no pin fills silence.
|
|
4862
|
+
*/
|
|
4863
|
+
get direction(): string | null
|
|
4864
|
+
/**
|
|
4865
|
+
* The source these options read under, folded: an entry of the
|
|
4866
|
+
* dictionary's sources catalog; `null` where none was named.
|
|
4867
|
+
*/
|
|
4868
|
+
get source(): string | null
|
|
4869
|
+
/**
|
|
4870
|
+
* These options sharing `underlyings` across their parses and lifecycles
|
|
4871
|
+
* (`MarketMessagesOptions::with_underlyings`): a parse resolves each
|
|
4872
|
+
* message against it in stream order, creates the rows it names and
|
|
4873
|
+
* the table holds none of, and fills the message from them - its
|
|
4874
|
+
* `underlyingcode` among them - so a search through the same table finds
|
|
4875
|
+
* what the parse wrote.
|
|
4876
|
+
*/
|
|
4877
|
+
withUnderlyings(underlyings: JsUnderlyings): MarketMessagesOptions
|
|
4878
|
+
/**
|
|
4879
|
+
* The underlyings these options resolve against, sharing them; `null`
|
|
4880
|
+
* where none was given and each walk starts from the seed.
|
|
4881
|
+
*/
|
|
4882
|
+
get underlyings(): JsUnderlyings | null
|
|
4883
|
+
/**
|
|
4884
|
+
* The raw bytes one Arrow batch targets.
|
|
4885
|
+
*
|
|
4886
|
+
* A byte count is a JavaScript number, exact to 2^53, as every count
|
|
4887
|
+
* at this boundary is.
|
|
4888
|
+
*/
|
|
4889
|
+
get batchByteSize(): number
|
|
4890
|
+
/** The rows one Arrow batch targets. */
|
|
4891
|
+
get batchRowSize(): number
|
|
4892
|
+
/** The workers parsing and row conversion use; available CPUs by default. */
|
|
4893
|
+
get threads(): number
|
|
4894
|
+
/**
|
|
4895
|
+
* The epoch-aligned lifecycle snapshot width in nanoseconds, or `null`
|
|
4896
|
+
* where snapshots are disabled.
|
|
4897
|
+
*/
|
|
4898
|
+
get snapshotNs(): bigint | null
|
|
4899
|
+
/**
|
|
4900
|
+
* These options with their lifecycle snapshot grid set to `snapshotNs`, an
|
|
4901
|
+
* epoch-aligned width in exact nanoseconds: `null`, zero and a negative
|
|
4902
|
+
* width disable snapshots. Every other setting, the dictionary included,
|
|
4903
|
+
* is these options', so a caller's options gain a grid without being
|
|
4904
|
+
* listed again.
|
|
4905
|
+
*/
|
|
4906
|
+
withSnapshotNs(snapshotNs: bigint | null): MarketMessagesOptions
|
|
4907
|
+
/**
|
|
4908
|
+
* Whether `intoLifecycle` reads its messages as they come, in instant
|
|
4909
|
+
* order, one epoch hour at a time.
|
|
4910
|
+
*/
|
|
4911
|
+
get sortedLifecycle(): boolean
|
|
4912
|
+
/**
|
|
4913
|
+
* These options with their lifecycle pinned to messages arriving in instant
|
|
4914
|
+
* order - a table read hour partition by hour partition, sorted by
|
|
4915
|
+
* `markettimestamp` - when `sorted`: the walk then holds one epoch hour at a
|
|
4916
|
+
* time, sorts within it exactly as a whole capture is sorted, and walks
|
|
4917
|
+
* an hour once a message two hours past it is read; a message dated
|
|
4918
|
+
* before an hour already walked is walked where it arrives. `false`
|
|
4919
|
+
* collects and sorts the whole capture. Every other setting is these
|
|
4920
|
+
* options'.
|
|
4921
|
+
*/
|
|
4922
|
+
withSortedLifecycle(sorted: boolean): MarketMessagesOptions
|
|
4923
|
+
/**
|
|
4924
|
+
* How far off a whole hour of its log line's clock a stated clock may
|
|
4925
|
+
* stand before it is `clock_skew`, in milliseconds; it dates nothing.
|
|
4926
|
+
*
|
|
4927
|
+
* A millisecond count is a JavaScript number, exact to 2^53, as every
|
|
4928
|
+
* count at this boundary is.
|
|
4929
|
+
*/
|
|
4930
|
+
get officialTimeDelayMs(): number
|
|
4931
|
+
/**
|
|
4932
|
+
* The message types a parse keeps, empty where it keeps every type the
|
|
4933
|
+
* refusals leave.
|
|
4934
|
+
*/
|
|
4935
|
+
get includeMsgtypes(): Array<string>
|
|
4936
|
+
/** The message types a parse refuses before it builds a frame. */
|
|
4937
|
+
get excludeMsgtypes(): Array<string>
|
|
4938
|
+
/**
|
|
4939
|
+
* Whether a market operation these options build carries, in its
|
|
4940
|
+
* metadata, what its message states that no typed column reads and no
|
|
4941
|
+
* identifier map of the leaf holds, and lifts the identifiers among
|
|
4942
|
+
* them into the set their type belongs to.
|
|
4943
|
+
*/
|
|
4944
|
+
get marketMetadata(): boolean
|
|
4945
|
+
/**
|
|
4946
|
+
* The `SendingTime` an undated message takes - one neither its row nor
|
|
4947
|
+
* its line dates - `DateTime64(ns, UTC)`, or `null` where each new
|
|
4948
|
+
* undated message reads the Unix epoch.
|
|
4949
|
+
*/
|
|
4950
|
+
get defaultSendingTime(): JsScalar | null
|
|
4951
|
+
/** The complete raw message code declared by captured bytes. */
|
|
4952
|
+
static inferMsgtypeBytes(body: Buffer): Buffer | null
|
|
4953
|
+
/** The complete raw message code declared by captured text. */
|
|
4954
|
+
static inferMsgtypeText(body: string): string | null
|
|
4955
|
+
/** A cheap clone: the dictionary and the pins are shared. */
|
|
4956
|
+
clone(): MarketMessagesOptions
|
|
4957
|
+
/** How these options render: the dictionary they read against. */
|
|
4958
|
+
toString(): string
|
|
4959
|
+
}
|
|
4960
|
+
export type JsMarketMessagesOptions = MarketMessagesOptions
|
|
4961
|
+
|
|
4850
4962
|
/** A base MIME type plus ordered transparent encodings. */
|
|
4851
4963
|
export declare class MediaType {
|
|
4852
4964
|
/** Parse/clone a media value or promote one MIME value. */
|
|
@@ -4863,8 +4975,6 @@ export declare class MediaType {
|
|
|
4863
4975
|
static fromPath(value: string): MediaType
|
|
4864
4976
|
/** Parse Content-Type and Content-Encoding header values together. */
|
|
4865
4977
|
static fromContentHeaders(contentType?: string | undefined | null, contentEncoding?: string | undefined | null): MediaType
|
|
4866
|
-
/** Deserialize the structural native JSON representation. */
|
|
4867
|
-
static fromJSON(value: any): MediaType
|
|
4868
4978
|
/** Underlying unencoded MIME type. */
|
|
4869
4979
|
get base(): MimeType
|
|
4870
4980
|
/** Ordered transparent encodings. */
|
|
@@ -4929,6 +5039,8 @@ export declare class MediaType {
|
|
|
4929
5039
|
isArchive(): boolean
|
|
4930
5040
|
/** Whether the encoded wire representation is certainly binary. */
|
|
4931
5041
|
isBinary(): boolean
|
|
5042
|
+
/** Deserialize the structural native JSON representation. */
|
|
5043
|
+
static fromJSON(value: any): MediaType
|
|
4932
5044
|
/** Exact normalized equality. */
|
|
4933
5045
|
equals(other: MediaType): boolean
|
|
4934
5046
|
/** Total native ordering: -1, 0, or 1. */
|
|
@@ -4999,8 +5111,6 @@ export declare class MimeType {
|
|
|
4999
5111
|
static fromContentType(value: string): MimeType
|
|
5000
5112
|
/** Parse one registered HTTP Content-Encoding token. */
|
|
5001
5113
|
static fromContentCoding(value: string): MimeType
|
|
5002
|
-
/** Deserialize the structural native JSON representation. */
|
|
5003
|
-
static fromJSON(value: any): MimeType
|
|
5004
5114
|
/** Top-level media category. */
|
|
5005
5115
|
get topLevel(): string
|
|
5006
5116
|
/** Media subtype. */
|
|
@@ -5049,6 +5159,8 @@ export declare class MimeType {
|
|
|
5049
5159
|
isArchive(): boolean
|
|
5050
5160
|
/** Whether the representation is conservatively binary. */
|
|
5051
5161
|
isBinary(): boolean
|
|
5162
|
+
/** Deserialize the structural native JSON representation. */
|
|
5163
|
+
static fromJSON(value: any): MimeType
|
|
5052
5164
|
/** Exact normalized equality. */
|
|
5053
5165
|
equals(other: MimeType): boolean
|
|
5054
5166
|
/** Total native ordering: -1, 0, or 1. */
|
|
@@ -5090,6 +5202,10 @@ export declare class MsgType {
|
|
|
5090
5202
|
identifierValues(message: MarketMessage): Array<[Field, Scalar]>
|
|
5091
5203
|
/** Look up the unique repeating group for a native counter tag. */
|
|
5092
5204
|
getGroupByTag(tag: number): Field | null
|
|
5205
|
+
/** Render the canonical native text. */
|
|
5206
|
+
toString(): string
|
|
5207
|
+
/** Project the native JSON representation. */
|
|
5208
|
+
toJSON(): any
|
|
5093
5209
|
/** Compare the complete native values. */
|
|
5094
5210
|
equals(other: MsgType): boolean
|
|
5095
5211
|
/** Compare native message definitions using their total ordering. */
|
|
@@ -5098,10 +5214,6 @@ export declare class MsgType {
|
|
|
5098
5214
|
stableHash(): bigint
|
|
5099
5215
|
/** Clone the native value, retaining shared backing. */
|
|
5100
5216
|
clone(): MsgType
|
|
5101
|
-
/** Render the canonical native text. */
|
|
5102
|
-
toString(): string
|
|
5103
|
-
/** Project the native JSON representation. */
|
|
5104
|
-
toJSON(): any
|
|
5105
5217
|
}
|
|
5106
5218
|
export type JsMsgType = MsgType
|
|
5107
5219
|
|
|
@@ -5311,12 +5423,12 @@ export declare class Parallelism {
|
|
|
5311
5423
|
get threads(): number
|
|
5312
5424
|
/** The same parallelism over `threads` threads. */
|
|
5313
5425
|
withThreads(threads: number): Parallelism
|
|
5314
|
-
/** Whether `other` states the same thread count. */
|
|
5315
|
-
equals(other: Parallelism): boolean
|
|
5316
5426
|
/** A cheap native clone. */
|
|
5317
5427
|
clone(): Parallelism
|
|
5318
5428
|
/** `Parallelism(threads=N)`. */
|
|
5319
5429
|
toString(): string
|
|
5430
|
+
/** Whether `other` states the same thread count. */
|
|
5431
|
+
equals(other: Parallelism): boolean
|
|
5320
5432
|
}
|
|
5321
5433
|
export type JsParallelism = Parallelism
|
|
5322
5434
|
|
|
@@ -5463,7 +5575,10 @@ export declare class Plan {
|
|
|
5463
5575
|
get columns(): Array<string>
|
|
5464
5576
|
/** The stored columns a read has to decode, or `null` for all of them. */
|
|
5465
5577
|
get readColumns(): Array<string> | null
|
|
5466
|
-
/**
|
|
5578
|
+
/**
|
|
5579
|
+
* Every parameter a run of this plan binds - its own sections' and
|
|
5580
|
+
* every plan it holds - in the order its text writes them.
|
|
5581
|
+
*/
|
|
5467
5582
|
get parameters(): Array<string>
|
|
5468
5583
|
/**
|
|
5469
5584
|
* The sections that shape a read - `select`, `where`, `order by`,
|
|
@@ -5497,12 +5612,12 @@ export declare class Plan {
|
|
|
5497
5612
|
explain(): string
|
|
5498
5613
|
/** Write this plan as a structural JSON document. */
|
|
5499
5614
|
intoJson(): string
|
|
5500
|
-
/** The canonical text, which re-parses to this plan. */
|
|
5501
|
-
toString(): string
|
|
5502
5615
|
/** Return whether two plans describe the same operation. */
|
|
5503
5616
|
equals(other: Plan | Selector | Filter | JsField | string): boolean
|
|
5504
5617
|
/** Compare two plans by the core's total structural order. */
|
|
5505
5618
|
compare(other: Plan | Selector | Filter | JsField | string): number
|
|
5619
|
+
/** The canonical text, which re-parses to this plan. */
|
|
5620
|
+
toString(): string
|
|
5506
5621
|
/** Return deterministic hash bits for the canonical plan text. */
|
|
5507
5622
|
stableHash(): bigint
|
|
5508
5623
|
/** Make a cheap native clone of this immutable plan. */
|
|
@@ -5605,20 +5720,6 @@ export declare class ProtocolField {
|
|
|
5605
5720
|
* `null` where there was none.
|
|
5606
5721
|
*/
|
|
5607
5722
|
removeTerm(): string | null
|
|
5608
|
-
/**
|
|
5609
|
-
* What crosses when a same-width integer of the other signedness meets
|
|
5610
|
-
* this integer column, on the `fieldProperties` view: `'bits'` where it
|
|
5611
|
-
* states them, `'value'` - the default - otherwise. Every other view
|
|
5612
|
-
* refuses the property.
|
|
5613
|
-
*/
|
|
5614
|
-
get representation(): 'value' | 'bits'
|
|
5615
|
-
/**
|
|
5616
|
-
* State what crosses when a same-width integer of the other signedness
|
|
5617
|
-
* meets this integer column; `'value'` or `null` removes the
|
|
5618
|
-
* declaration, and `'bits'` on a column that is no integer is refused,
|
|
5619
|
-
* leaving the field unchanged.
|
|
5620
|
-
*/
|
|
5621
|
-
set representation(representation: 'value' | 'bits' | null)
|
|
5622
5723
|
/**
|
|
5623
5724
|
* The sources that contributed this field, on the `fix` view.
|
|
5624
5725
|
*
|
|
@@ -6470,8 +6571,6 @@ export declare class Scalar {
|
|
|
6470
6571
|
intoArrayField(): Field
|
|
6471
6572
|
/** Infer a non-null Struct root from named Record rows. */
|
|
6472
6573
|
intoStructField(): Field
|
|
6473
|
-
/** Return deterministic hash bits shared with Rust and Python. */
|
|
6474
|
-
stableHash(): bigint
|
|
6475
6574
|
/**
|
|
6476
6575
|
* This value as the value stream: one `Buffer` holding the version,
|
|
6477
6576
|
* the datatype's identifier and the payload the identifier says how
|
|
@@ -6497,15 +6596,6 @@ export declare class Scalar {
|
|
|
6497
6596
|
* rather than its storage width.
|
|
6498
6597
|
*/
|
|
6499
6598
|
digest(algorithm?: string | undefined | null): Digest
|
|
6500
|
-
/**
|
|
6501
|
-
* Compare two native values by the core's total value order.
|
|
6502
|
-
*
|
|
6503
|
-
* Numeric widths compare by value, as equality does: `i8(1)` and
|
|
6504
|
-
* `u64(1)` compare equal, and exact decimals are normalized first.
|
|
6505
|
-
*/
|
|
6506
|
-
compare(other: Scalar): number
|
|
6507
|
-
/** Make a cheap native clone without projecting through JavaScript. */
|
|
6508
|
-
clone(): Scalar
|
|
6509
6599
|
/** Borrow binary content as a Buffer, or `null` for another kind. */
|
|
6510
6600
|
asBytes(): Buffer | null
|
|
6511
6601
|
/**
|
|
@@ -6527,6 +6617,17 @@ export declare class Scalar {
|
|
|
6527
6617
|
toJSON(): any
|
|
6528
6618
|
/** Natural compact JSON for the standard JavaScript string protocol. */
|
|
6529
6619
|
toString(): string
|
|
6620
|
+
/** Return deterministic hash bits shared with Rust and Python. */
|
|
6621
|
+
stableHash(): bigint
|
|
6622
|
+
/**
|
|
6623
|
+
* Compare two native values by the core's total value order.
|
|
6624
|
+
*
|
|
6625
|
+
* Numeric widths compare by value, as equality does: `i8(1)` and
|
|
6626
|
+
* `u64(1)` compare equal, and exact decimals are normalized first.
|
|
6627
|
+
*/
|
|
6628
|
+
compare(other: Scalar): number
|
|
6629
|
+
/** Make a cheap native clone without projecting through JavaScript. */
|
|
6630
|
+
clone(): Scalar
|
|
6530
6631
|
/**
|
|
6531
6632
|
* Whether two native values are the same value.
|
|
6532
6633
|
*
|
|
@@ -6700,12 +6801,12 @@ export declare class Selector {
|
|
|
6700
6801
|
explain(): string
|
|
6701
6802
|
/** Write this selector as a structural JSON document. */
|
|
6702
6803
|
intoJson(): string
|
|
6703
|
-
/** The canonical text, which re-parses to this selector. */
|
|
6704
|
-
toString(): string
|
|
6705
6804
|
/** Return whether two selectors publish the same columns. */
|
|
6706
6805
|
equals(other: Selector | Term | string | Array<Term | string>): boolean
|
|
6707
6806
|
/** Compare two selectors by the core's total structural order. */
|
|
6708
6807
|
compare(other: Selector | Term | string | Array<Term | string>): number
|
|
6808
|
+
/** The canonical text, which re-parses to this selector. */
|
|
6809
|
+
toString(): string
|
|
6709
6810
|
/** Return deterministic hash bits for the canonical selector text. */
|
|
6710
6811
|
stableHash(): bigint
|
|
6711
6812
|
/** Make a cheap native clone of this immutable selector. */
|
|
@@ -6733,7 +6834,11 @@ export declare class Serie {
|
|
|
6733
6834
|
get dtype(): DataType
|
|
6734
6835
|
/** Whether this is a column rather than a schema-free run. */
|
|
6735
6836
|
get isColumn(): boolean
|
|
6736
|
-
/**
|
|
6837
|
+
/**
|
|
6838
|
+
* The row count: every row the serie holds, a lazy stream whose pull
|
|
6839
|
+
* was refused throwing the refusal rather than count the rows before
|
|
6840
|
+
* it.
|
|
6841
|
+
*/
|
|
6737
6842
|
get length(): number
|
|
6738
6843
|
/** The rows that are absent. */
|
|
6739
6844
|
nullCount(): number
|
|
@@ -6748,7 +6853,10 @@ export declare class Serie {
|
|
|
6748
6853
|
* JSON document whole, so a 64-bit integer inside one is a number.
|
|
6749
6854
|
*/
|
|
6750
6855
|
toRecords(): Array<Record<string, unknown>>
|
|
6751
|
-
/**
|
|
6856
|
+
/**
|
|
6857
|
+
* This serie as the one value a `Scalar` sequence holds: every row it
|
|
6858
|
+
* holds, a refused stream throwing its refusal.
|
|
6859
|
+
*/
|
|
6752
6860
|
intoScalar(): Scalar
|
|
6753
6861
|
/** Remove row `index` and answer it. */
|
|
6754
6862
|
remove(index: number): Scalar
|
|
@@ -6819,13 +6927,23 @@ export declare class Serie {
|
|
|
6819
6927
|
* r" and a root declaring none.
|
|
6820
6928
|
*/
|
|
6821
6929
|
declaredOrder(): Array<string> | null
|
|
6822
|
-
|
|
6823
|
-
|
|
6824
|
-
/** Moves these values into native chunks under optional row and byte bounds. */
|
|
6825
|
-
intoChunkedStream(rowSize?: number | undefined | null, byteSize?: number | undefined | null): StreamChunkedSerie
|
|
6930
|
+
|
|
6931
|
+
|
|
6826
6932
|
}
|
|
6827
6933
|
export type JsSerie = Serie
|
|
6828
6934
|
|
|
6935
|
+
/**
|
|
6936
|
+
* The record columns a serie yields, one per batch: `Serie.intoChunks`.
|
|
6937
|
+
*
|
|
6938
|
+
* A held column is its one record column, chunks one each, and a lazy
|
|
6939
|
+
* serie its batches as its source yields them; a source's failure surfaces
|
|
6940
|
+
* at the pull that meets it and ends the walk.
|
|
6941
|
+
*/
|
|
6942
|
+
export declare class SerieChunks {
|
|
6943
|
+
|
|
6944
|
+
}
|
|
6945
|
+
export type JsSerieChunks = SerieChunks
|
|
6946
|
+
|
|
6829
6947
|
/**
|
|
6830
6948
|
* An owning iterator over a serie's rows, each built once.
|
|
6831
6949
|
*
|
|
@@ -7098,13 +7216,14 @@ export declare class SnapshotRef {
|
|
|
7098
7216
|
export type JsSnapshotRef = SnapshotRef
|
|
7099
7217
|
|
|
7100
7218
|
/**
|
|
7101
|
-
* The bound a column stays resident under, the budget the process
|
|
7102
|
-
*
|
|
7219
|
+
* The bound a column stays resident under, the budget the process keeps
|
|
7220
|
+
* resident under before its holders are pressed, and the folder they spill
|
|
7221
|
+
* to.
|
|
7103
7222
|
*
|
|
7104
7223
|
* `byteSize` is the resident bytes a column may hold before it spills;
|
|
7105
7224
|
* `SpillOptions.NEVER` spills nothing and `0` everything. `budget` is what
|
|
7106
|
-
* every
|
|
7107
|
-
* for no cap. `folder` is where the files are created, the platform temporary
|
|
7225
|
+
* the process - its holders and every serie a caller keeps - may keep
|
|
7226
|
+
* resident before its holders are pressed, `SpillOptions.NEVER` for no cap. `folder` is where the files are created, the platform temporary
|
|
7108
7227
|
* folder when `null`. Every spill file is private to the process and gone from
|
|
7109
7228
|
* the folder as soon as it is opened, so a crash leaves nothing behind.
|
|
7110
7229
|
*/
|
|
@@ -7120,10 +7239,12 @@ export declare class SpillOptions {
|
|
|
7120
7239
|
* The options the process environment states, read on the first call
|
|
7121
7240
|
* and the same value after: `YGGIO_SPILL_BYTE_SIZE` the bound - a byte
|
|
7122
7241
|
* count, or `never` in any case - `YGGIO_SPILL_BUDGET` the process
|
|
7123
|
-
* budget, spelled the same way,
|
|
7124
|
-
*
|
|
7125
|
-
* `
|
|
7126
|
-
* the
|
|
7242
|
+
* budget, spelled the same way, `YGGIO_SPILL_MAPPINGS` the cap on the
|
|
7243
|
+
* live spill mappings (which no door of this package states) and
|
|
7244
|
+
* `YGGIO_SPILL_FOLDER` the folder, either unset or empty the default
|
|
7245
|
+
* (the host's budget and map count on Linux where none is stated). A
|
|
7246
|
+
* refused variable is named, and the next call reads the environment
|
|
7247
|
+
* again.
|
|
7127
7248
|
*/
|
|
7128
7249
|
static fromEnv(): SpillOptions
|
|
7129
7250
|
/**
|
|
@@ -7134,14 +7255,15 @@ export declare class SpillOptions {
|
|
|
7134
7255
|
*/
|
|
7135
7256
|
static installEnv(options: SpillOptions): void
|
|
7136
7257
|
/**
|
|
7137
|
-
* What the process
|
|
7138
|
-
*
|
|
7258
|
+
* What the process keeps resident now - its holders and every serie a
|
|
7259
|
+
* caller keeps - and kept at most, and what spilling wrote: the
|
|
7260
|
+
* process ledger, read once per count.
|
|
7139
7261
|
*/
|
|
7140
7262
|
static stats(): SpillStats
|
|
7141
7263
|
/** The resident bytes a column may hold before it spills. */
|
|
7142
7264
|
get byteSize(): bigint
|
|
7143
7265
|
/**
|
|
7144
|
-
* What
|
|
7266
|
+
* What the process may keep resident before its holders are pressed,
|
|
7145
7267
|
* `SpillOptions.NEVER` for no cap.
|
|
7146
7268
|
*/
|
|
7147
7269
|
get budget(): bigint
|
|
@@ -7155,70 +7277,28 @@ export declare class SpillOptions {
|
|
|
7155
7277
|
/** The same bound and folder under another process budget. */
|
|
7156
7278
|
withBudget(budget: number | bigint): SpillOptions
|
|
7157
7279
|
/**
|
|
7158
|
-
* The same
|
|
7159
|
-
*
|
|
7280
|
+
* The same options over another folder, `null` or `undefined` for the
|
|
7281
|
+
* platform temporary folder: the bound, the budget and the mapping cap
|
|
7282
|
+
* kept.
|
|
7160
7283
|
*/
|
|
7161
7284
|
withFolder(folder?: IOBase | Url | Uri | Urn | Arn | string | null | undefined): SpillOptions
|
|
7162
7285
|
/** Whether the bound is `SpillOptions.NEVER`: nothing spills. */
|
|
7163
7286
|
isNever(): boolean
|
|
7164
|
-
/**
|
|
7165
|
-
* Whether `other` states the same bound and budget over the same folder:
|
|
7166
|
-
* two folders are one when they name one location.
|
|
7167
|
-
*/
|
|
7168
|
-
equals(other: SpillOptions): boolean
|
|
7169
|
-
/** A cheap native clone. */
|
|
7170
|
-
clone(): SpillOptions
|
|
7171
7287
|
/**
|
|
7172
7288
|
* The bound - `never` for `SpillOptions.NEVER` - then the folder's URL
|
|
7173
7289
|
* and the budget where they are stated:
|
|
7174
7290
|
* `SpillOptions(byteSize=0, folder=file:///spill, budget=4096)`.
|
|
7175
7291
|
*/
|
|
7176
7292
|
toString(): string
|
|
7177
|
-
}
|
|
7178
|
-
export type JsSpillOptions = SpillOptions
|
|
7179
|
-
|
|
7180
|
-
/**
|
|
7181
|
-
* One record serie per batch of a native `BatchReader`, each cast by the
|
|
7182
|
-
* one plan the core compiled from the stream's schema, or the one record
|
|
7183
|
-
* serie a held column is.
|
|
7184
|
-
*
|
|
7185
|
-
* The reader is a stream, read once: iterating it, `cast` and
|
|
7186
|
-
* `intoArrowReader` each consume it, and a batch's failure surfaces at the
|
|
7187
|
-
* pull that read it.
|
|
7188
|
-
*/
|
|
7189
|
-
export declare class StreamChunkedSerie {
|
|
7190
|
-
/** The record every yielded serie is typed by. */
|
|
7191
|
-
get field(): Field
|
|
7192
|
-
/**
|
|
7193
|
-
* The bytes the records this reader holds occupy in memory: the held
|
|
7194
|
-
* records still to yield, or the batch a window's walk stands in; a
|
|
7195
|
-
* stream holds no landed batch between pulls, and a consumed reader
|
|
7196
|
-
* nothing, and both answer zero.
|
|
7197
|
-
*/
|
|
7198
|
-
residentSize(): number
|
|
7199
|
-
/**
|
|
7200
|
-
* Whether every record this reader holds lies in a spill file: held
|
|
7201
|
-
* records only, never a stream, which holds none.
|
|
7202
|
-
*/
|
|
7203
|
-
isSpilled(): boolean
|
|
7204
7293
|
/**
|
|
7205
|
-
*
|
|
7206
|
-
*
|
|
7207
|
-
* each held record as `Serie.spill` moves it; a stream holds none and
|
|
7208
|
-
* is untouched. Refused once the reader was taken.
|
|
7209
|
-
*/
|
|
7210
|
-
spill(options?: JsSpillOptions | undefined | null): void
|
|
7211
|
-
/**
|
|
7212
|
-
* The stream's batches reconciled to the root as a native
|
|
7213
|
-
* `BatchReader`, never landed; the reader is consumed.
|
|
7294
|
+
* Whether `other` states the same bound and budget over the same folder:
|
|
7295
|
+
* two folders are one when they name one location.
|
|
7214
7296
|
*/
|
|
7215
|
-
|
|
7216
|
-
/**
|
|
7217
|
-
|
|
7218
|
-
/** Moves these values into native chunks under optional row and byte bounds. */
|
|
7219
|
-
intoChunkedStream(rowSize?: number | undefined | null, byteSize?: number | undefined | null): StreamChunkedSerie
|
|
7297
|
+
equals(other: SpillOptions): boolean
|
|
7298
|
+
/** A cheap native clone. */
|
|
7299
|
+
clone(): SpillOptions
|
|
7220
7300
|
}
|
|
7221
|
-
export type
|
|
7301
|
+
export type JsSpillOptions = SpillOptions
|
|
7222
7302
|
|
|
7223
7303
|
/** Writes each record as one line to standard error or standard output. */
|
|
7224
7304
|
export declare class StreamHandler {
|
|
@@ -7256,41 +7336,15 @@ export declare class StreamKeySerie {
|
|
|
7256
7336
|
get serieField(): Field
|
|
7257
7337
|
/** Source paths for moved columns; computed and external keys have no path. */
|
|
7258
7338
|
get keyPaths(): Array<JsFieldPath | undefined | null>
|
|
7259
|
-
/** Moves these values into a native scalar-row stream. */
|
|
7260
|
-
intoStream(): StreamSerie
|
|
7261
|
-
/** Moves these values into native chunks under optional row and byte bounds. */
|
|
7262
|
-
intoChunkedStream(rowSize?: number | undefined | null, byteSize?: number | undefined | null): JsStreamChunkedSerie
|
|
7263
7339
|
}
|
|
7264
7340
|
export type JsStreamKeySerie = StreamKeySerie
|
|
7265
7341
|
|
|
7266
|
-
/**
|
|
7267
|
-
* Native rows streaming out of an expression, each a `Scalar` sequence in
|
|
7268
|
-
* the order of `field`.
|
|
7269
|
-
*/
|
|
7270
|
-
export declare class StreamSerie {
|
|
7271
|
-
/** The struct root every row is shaped under. */
|
|
7272
|
-
get field(): JsField
|
|
7273
|
-
/** The remaining rows as a native batch reader, batched lazily. */
|
|
7274
|
-
intoArrowReader(): JsBatchReader
|
|
7275
|
-
/** The records a native batch reader holds, one row at a time. */
|
|
7276
|
-
static fromArrowReader(reader: JsBatchReader): StreamSerie
|
|
7277
|
-
/** The struct root the rows are shaped under, as text. */
|
|
7278
|
-
toString(): string
|
|
7279
|
-
/** Collects the remaining rows in one native call and consumes the stream. */
|
|
7280
|
-
collect(): Array<JsScalar>
|
|
7281
|
-
/** Moves these values into a native scalar-row stream. */
|
|
7282
|
-
intoStream(): StreamSerie
|
|
7283
|
-
/** Moves these values into native chunks under optional row and byte bounds. */
|
|
7284
|
-
intoChunkedStream(rowSize?: number | undefined | null, byteSize?: number | undefined | null): JsStreamChunkedSerie
|
|
7285
|
-
}
|
|
7286
|
-
export type JsStreamSerie = StreamSerie
|
|
7287
|
-
|
|
7288
7342
|
/**
|
|
7289
7343
|
* The enum a string field's values name: one value per member name.
|
|
7290
7344
|
*
|
|
7291
7345
|
* A dictionary is a vocabulary and derives its member names; this is the
|
|
7292
7346
|
* vocabulary a declaration named itself, and it is what a `Field` stores
|
|
7293
|
-
* under `
|
|
7347
|
+
* under `enum` so the enum crosses Arrow, a file, and another runtime
|
|
7294
7348
|
* intact. The width lives in the field's datatype - a fixed US-ASCII string
|
|
7295
7349
|
* of at most sixteen bytes or a code - so a member's code is its packed
|
|
7296
7350
|
* ASCII value under that width and never a position.
|
|
@@ -7298,9 +7352,9 @@ export type JsStreamSerie = StreamSerie
|
|
|
7298
7352
|
export declare class StringEnum {
|
|
7299
7353
|
/** Create an enum from its members, one ASCII value per member name. */
|
|
7300
7354
|
constructor(name: string, members?: Record<string, string> | undefined | null)
|
|
7301
|
-
/** Parse the `
|
|
7355
|
+
/** Parse the `enum` document. */
|
|
7302
7356
|
static fromJson(document: string): StringEnum
|
|
7303
|
-
/** Render the `
|
|
7357
|
+
/** Render the `enum` document, which is one text per enum. */
|
|
7304
7358
|
intoJson(): string
|
|
7305
7359
|
/** The enum's own name, which is not the field's name. */
|
|
7306
7360
|
get name(): string
|
|
@@ -7327,12 +7381,12 @@ export declare class StringEnum {
|
|
|
7327
7381
|
static memberName(value: string): string
|
|
7328
7382
|
/** The number of members. */
|
|
7329
7383
|
get length(): number
|
|
7384
|
+
/** The `enum` document, which is the enum's one canonical text. */
|
|
7385
|
+
toString(): string
|
|
7330
7386
|
/** Native equality: the enum name and every member it names. */
|
|
7331
7387
|
equals(other: StringEnum): boolean
|
|
7332
7388
|
/** Make a native clone that changes independently of this enum. */
|
|
7333
7389
|
clone(): StringEnum
|
|
7334
|
-
/** The `FIELD:enum` document, which is the enum's one canonical text. */
|
|
7335
|
-
toString(): string
|
|
7336
7390
|
}
|
|
7337
7391
|
export type JsStringEnum = StringEnum
|
|
7338
7392
|
|
|
@@ -7624,12 +7678,12 @@ export declare class Term {
|
|
|
7624
7678
|
intoJson(): string
|
|
7625
7679
|
/** The output field this term produces against a schema. */
|
|
7626
7680
|
field(schema: JsField): JsField
|
|
7627
|
-
/** The canonical text, which re-parses to this term. */
|
|
7628
|
-
toString(): string
|
|
7629
7681
|
/** Return whether two terms are the same tree. */
|
|
7630
7682
|
equals(other: Term | string): boolean
|
|
7631
7683
|
/** Compare two terms by the core's total structural order. */
|
|
7632
7684
|
compare(other: Term | string): number
|
|
7685
|
+
/** The canonical text, which re-parses to this term. */
|
|
7686
|
+
toString(): string
|
|
7633
7687
|
/** Return deterministic hash bits for the canonical term text. */
|
|
7634
7688
|
stableHash(): bigint
|
|
7635
7689
|
/** Make a cheap native clone of this immutable tree. */
|
|
@@ -7684,8 +7738,9 @@ export declare class TextLine {
|
|
|
7684
7738
|
* A capture states what a row header matched about the line, in the
|
|
7685
7739
|
* order the header declares them, and `null` is a capture it declared
|
|
7686
7740
|
* and this line did not match; stated, the captures are the line's word
|
|
7687
|
-
* over its own header.
|
|
7688
|
-
* is the contract and `
|
|
7741
|
+
* over its own header. A parse reads them by position, so the order
|
|
7742
|
+
* is the contract and `MarketMessagesOptions`' `captureNames` is what
|
|
7743
|
+
* names it.
|
|
7689
7744
|
*
|
|
7690
7745
|
* The body is copied into a page this line owns, once: every key and
|
|
7691
7746
|
* value a message read from it records is a range of that page. A
|
|
@@ -7747,7 +7802,7 @@ export declare class TextLine {
|
|
|
7747
7802
|
* The line's identity, as its hyphenated text: `UUIDv7` ordered by its
|
|
7748
7803
|
* millisecond and row number, with a seeded payload over its content. A
|
|
7749
7804
|
* line is an event of the
|
|
7750
|
-
* graph, and a message parsed out of it states this among its `
|
|
7805
|
+
* graph, and a message parsed out of it states this among its `sourceuuids`.
|
|
7751
7806
|
*/
|
|
7752
7807
|
get uuid(): string
|
|
7753
7808
|
/**
|
|
@@ -7768,12 +7823,12 @@ export declare class TextLine {
|
|
|
7768
7823
|
* When the line happened, nanoseconds since the Unix epoch, UTC: the
|
|
7769
7824
|
* stated instant, else `mtime`, else `0n`.
|
|
7770
7825
|
*/
|
|
7771
|
-
get
|
|
7826
|
+
get markettimestamp(): bigint
|
|
7772
7827
|
/**
|
|
7773
7828
|
* Where the line stands in its source: the row number under
|
|
7774
7829
|
* `startRownum`, else its zero-based physical `index`.
|
|
7775
7830
|
*/
|
|
7776
|
-
get
|
|
7831
|
+
get sequencenumber(): bigint
|
|
7777
7832
|
/**
|
|
7778
7833
|
* The row header's named captures, in the order the expression declares
|
|
7779
7834
|
* them; resolved on the first ask where none were stated.
|
|
@@ -8138,6 +8193,10 @@ export declare class Timezone {
|
|
|
8138
8193
|
* the core's, so a zone can stand in wherever a `Date` offset is read.
|
|
8139
8194
|
*/
|
|
8140
8195
|
getTimezoneOffset(epoch: number): number | null
|
|
8196
|
+
/** Return the canonical name, accepted losslessly by `fromString`. */
|
|
8197
|
+
toString(): string
|
|
8198
|
+
/** Serialize as the canonical name, so a zone survives `JSON.stringify`. */
|
|
8199
|
+
toJSON(): string
|
|
8141
8200
|
/** Exact canonical equality: two spellings of one zone are equal. */
|
|
8142
8201
|
equals(other: Timezone): boolean
|
|
8143
8202
|
/** Total native ordering: `-1`, `0`, or `1`. */
|
|
@@ -8146,10 +8205,6 @@ export declare class Timezone {
|
|
|
8146
8205
|
stableHash(): bigint
|
|
8147
8206
|
/** Make a cheap native clone. */
|
|
8148
8207
|
clone(): Timezone
|
|
8149
|
-
/** Return the canonical name, accepted losslessly by `fromString`. */
|
|
8150
|
-
toString(): string
|
|
8151
|
-
/** Serialize as the canonical name, so a zone survives `JSON.stringify`. */
|
|
8152
|
-
toJSON(): string
|
|
8153
8208
|
}
|
|
8154
8209
|
export type JsTimezone = Timezone
|
|
8155
8210
|
|
|
@@ -8273,7 +8328,8 @@ export type JsTxHasher = TxHasher
|
|
|
8273
8328
|
* The table of underlyings (`yggio_market::Underlyings`), its essential
|
|
8274
8329
|
* doors: the seed, a row by code, a search. Rows cross as a `Serie` under
|
|
8275
8330
|
* `fixUnderlyingField()`, the field the seed's rows are read under. The
|
|
8276
|
-
* table is shared:
|
|
8331
|
+
* table is shared: options it is given to
|
|
8332
|
+
* (`MarketMessagesOptions.withUnderlyings`)
|
|
8277
8333
|
* resolves its messages against it and creates the rows they name.
|
|
8278
8334
|
*/
|
|
8279
8335
|
export declare class Underlyings {
|
|
@@ -8288,6 +8344,13 @@ export declare class Underlyings {
|
|
|
8288
8344
|
* `Serie` under `fixUnderlyingField()`; `null` where none.
|
|
8289
8345
|
*/
|
|
8290
8346
|
get(code: string): JsSerie | null
|
|
8347
|
+
/**
|
|
8348
|
+
* Every row the table holds now, in the registry's code order
|
|
8349
|
+
* (`Registry::into_serie`): the seed's and every row a parse given the
|
|
8350
|
+
* table filled or created - a disputed code's dispute rows beside its
|
|
8351
|
+
* row - as one `Serie` under `fixUnderlyingField()`.
|
|
8352
|
+
*/
|
|
8353
|
+
rows(): JsSerie
|
|
8291
8354
|
/**
|
|
8292
8355
|
* The rows `text` names, strongest first, each once, at most `limit`
|
|
8293
8356
|
* (20 by default) (`Underlyings::search`): the exact code, an
|
|
@@ -8295,6 +8358,19 @@ export declare class Underlyings {
|
|
|
8295
8358
|
* a `Serie` under `fixUnderlyingField()`, empty for a blank text.
|
|
8296
8359
|
*/
|
|
8297
8360
|
search(text: string, limit?: number | undefined | null): JsSerie
|
|
8361
|
+
/**
|
|
8362
|
+
* The one message search (`MessageSearch::plan`): `text` read against
|
|
8363
|
+
* this table, the plugins of `options.registry` where one is given and
|
|
8364
|
+
* the root `field` into one plan over the message rows - a UUID the
|
|
8365
|
+
* `uuid` column reads alone; else the underlying, plugin and identifier
|
|
8366
|
+
* branches OR-ed, each carrying its own pruning, the like fallback only
|
|
8367
|
+
* where nothing resolved - the window `[since, until)` on `markettimestamp`,
|
|
8368
|
+
* each nanoseconds since the epoch, at the top, newest first; `null`
|
|
8369
|
+
* for a blank text. `limit` bounds the underlying rows a branch names,
|
|
8370
|
+
* 20 when unstated. A root holding none of the columns the search reads
|
|
8371
|
+
* throws at `$.search`.
|
|
8372
|
+
*/
|
|
8373
|
+
messageSearch(text: string, field: Field, options?: MessageSearchOptions): Plan | null
|
|
8298
8374
|
/** How many rows the table holds (`Underlyings::len`). */
|
|
8299
8375
|
get length(): number
|
|
8300
8376
|
}
|
|
@@ -8306,91 +8382,12 @@ export declare class Uri {
|
|
|
8306
8382
|
constructor(value: Uri | JsUrl | JsUrn | JsArn | string)
|
|
8307
8383
|
/** Infer a URI from a native wrapper or URI-expression string. */
|
|
8308
8384
|
static from(value: Uri | JsUrl | JsUrn | JsArn | string): Uri
|
|
8309
|
-
/** Parse and normalize an absolute URI. */
|
|
8310
|
-
static fromString(value: string): Uri
|
|
8311
|
-
/** Convert a local, Windows-drive, or UNC path into a normalized file URI. */
|
|
8312
|
-
static fromPath(value: string): Uri
|
|
8313
8385
|
/** Validate and project this general URI as a hierarchical URL. */
|
|
8314
8386
|
intoUrl(): JsUrl
|
|
8315
8387
|
/** Validate and project this general URI as a URN. */
|
|
8316
8388
|
intoUrn(): JsUrn
|
|
8317
8389
|
/** Validate and project this general URI as an ARN. */
|
|
8318
8390
|
intoArn(): JsArn
|
|
8319
|
-
/**
|
|
8320
|
-
* The location this identifier names, as a `Url`.
|
|
8321
|
-
*
|
|
8322
|
-
* A location locates itself; a name resolves to where it is - a URN under
|
|
8323
|
-
* the process working directory, an Amazon S3 ARN to the `s3:` URL its
|
|
8324
|
-
* bucket and key address - which is what lets any identifier be handed to
|
|
8325
|
-
* a reader as the thing to open.
|
|
8326
|
-
*/
|
|
8327
|
-
locator(): JsUrl
|
|
8328
|
-
/** Decode this file URI as a host-independent forward-slash path. */
|
|
8329
|
-
intoPath(): string
|
|
8330
|
-
/** Deserialize the native structural JSON representation. */
|
|
8331
|
-
static fromJSON(value: any): Uri
|
|
8332
|
-
/** Normalized, non-empty URI scheme. */
|
|
8333
|
-
get scheme(): string
|
|
8334
|
-
/** Normalized URI authority, empty when the URI has no authority. */
|
|
8335
|
-
get authority(): string
|
|
8336
|
-
/** User name from URI user information. */
|
|
8337
|
-
get user(): string | null
|
|
8338
|
-
/** Password after the first user-information colon. */
|
|
8339
|
-
get password(): string | null
|
|
8340
|
-
/** Network hostname under the core store-aware rules. */
|
|
8341
|
-
get hostname(): string | null
|
|
8342
|
-
/**
|
|
8343
|
-
* Container name - a bucket on Amazon S3 and Google, a container on
|
|
8344
|
-
* Azure, a table bucket on Amazon S3 Tables - or `null` for a scheme that
|
|
8345
|
-
* names no store.
|
|
8346
|
-
*/
|
|
8347
|
-
get bucket(): string | null
|
|
8348
|
-
/** Azure storage account this location names, when it names one. */
|
|
8349
|
-
get account(): string | null
|
|
8350
|
-
/** Object key: the path below the container, as the path spells it. */
|
|
8351
|
-
get key(): string | null
|
|
8352
|
-
/** Region inferred from a recognized store hostname. */
|
|
8353
|
-
get region(): string | null
|
|
8354
|
-
/** Store endpoint host with its explicit port, without a virtual container. */
|
|
8355
|
-
get storeEndpoint(): string | null
|
|
8356
|
-
/** Whether this location writes its container into the hostname. */
|
|
8357
|
-
isVirtualHosted(): boolean
|
|
8358
|
-
/** Normalized slash-separated URI path. */
|
|
8359
|
-
get path(): string
|
|
8360
|
-
/** Query text without the leading question mark. */
|
|
8361
|
-
get query(): string | null
|
|
8362
|
-
/** Fragment text without the leading hash mark. */
|
|
8363
|
-
get fragment(): string | null
|
|
8364
|
-
/** Last non-empty path segment. */
|
|
8365
|
-
get fileName(): string | null
|
|
8366
|
-
/** Filename without its final non-empty extension. */
|
|
8367
|
-
get stem(): string | null
|
|
8368
|
-
/** Final filename extension without a leading dot. */
|
|
8369
|
-
get extension(): string | null
|
|
8370
|
-
/** All filename extensions in lexical order from left to right. */
|
|
8371
|
-
get extensions(): Array<string>
|
|
8372
|
-
/** Replace the final filename segment or append one to a directory path. */
|
|
8373
|
-
setFileName(value: string): void
|
|
8374
|
-
/** Replace the filename stem while preserving its final extension. */
|
|
8375
|
-
setStem(value: string): void
|
|
8376
|
-
/** Add or replace the final filename extension. */
|
|
8377
|
-
setExtension(value: string): void
|
|
8378
|
-
/** Replace the complete compound filename extension chain. */
|
|
8379
|
-
setExtensions(values: Array<string>): void
|
|
8380
|
-
/** Remove the final filename extension. */
|
|
8381
|
-
removeExtension(): boolean
|
|
8382
|
-
/** Remove every filename extension. */
|
|
8383
|
-
clearExtensions(): boolean
|
|
8384
|
-
/** MIME type inferred from the final suffix. */
|
|
8385
|
-
get mimeType(): MimeType
|
|
8386
|
-
/** Base MIME type and transparent encodings inferred from all suffixes. */
|
|
8387
|
-
get mediaType(): MediaType
|
|
8388
|
-
/** Replace the final suffix using a MIME preferred extension. */
|
|
8389
|
-
setMimeType(value: MimeTypeInput): void
|
|
8390
|
-
/** Replace the full suffix chain using a media type. */
|
|
8391
|
-
setMediaType(value: MediaTypeInput): void
|
|
8392
|
-
/** Non-empty path segments in path order. */
|
|
8393
|
-
get pathSegments(): Array<string>
|
|
8394
8391
|
/**
|
|
8395
8392
|
* Join path components through the generic URI core.
|
|
8396
8393
|
*
|
|
@@ -8398,52 +8395,26 @@ export declare class Uri {
|
|
|
8398
8395
|
* the explicit spelling of Rust and Python's path-composition idiom.
|
|
8399
8396
|
*/
|
|
8400
8397
|
joinPath(others: Array<string>): Uri
|
|
8401
|
-
/**
|
|
8402
|
-
|
|
8403
|
-
/**
|
|
8404
|
-
|
|
8405
|
-
/** Exact normalized native equality. */
|
|
8406
|
-
equals(other: Uri): boolean
|
|
8407
|
-
/** Total native ordering: `-1`, `0`, or `1`. */
|
|
8408
|
-
compare(other: Uri): number
|
|
8409
|
-
/** Deterministic XXH3-64 hash of the canonical URI. */
|
|
8410
|
-
stableHash(): bigint
|
|
8411
|
-
/** Make a cheap native clone. */
|
|
8412
|
-
clone(): Uri
|
|
8413
|
-
/** Return canonical syntax accepted losslessly by `fromString`. */
|
|
8414
|
-
toString(): string
|
|
8415
|
-
/** Serialize to version-independent structural JSON. */
|
|
8416
|
-
toJSON(): any
|
|
8417
|
-
}
|
|
8418
|
-
export type JsUri = Uri
|
|
8419
|
-
|
|
8420
|
-
/** A normalized hierarchical URL backed by the validated Rust core. */
|
|
8421
|
-
export declare class Url {
|
|
8422
|
-
/** Parse/convert a `Url`, any identifier naming one, or location text. */
|
|
8423
|
-
constructor(value: Url | Uri | JsUrn | JsArn | string)
|
|
8424
|
-
/** Infer a URL from any native identifier wrapper or location text. */
|
|
8425
|
-
static from(value: Url | Uri | JsUrn | JsArn | string): Url
|
|
8426
|
-
/** Parse and validate a hierarchical URL. */
|
|
8427
|
-
static fromString(value: string): Url
|
|
8428
|
-
/** Convert a local, Windows-drive, or UNC path into a normalized file URL. */
|
|
8429
|
-
static fromPath(value: string): Url
|
|
8430
|
-
/** Decode this file URL as a host-independent forward-slash path. */
|
|
8431
|
-
intoPath(): string
|
|
8398
|
+
/** Parse and normalize an absolute URI. */
|
|
8399
|
+
static fromString(value: string): Uri
|
|
8400
|
+
/** Convert a local, Windows-drive, or UNC path into a normalized file URI. */
|
|
8401
|
+
static fromPath(value: string): Uri
|
|
8432
8402
|
/**
|
|
8433
|
-
*
|
|
8403
|
+
* The location this identifier names, as a `Url`.
|
|
8434
8404
|
*
|
|
8435
|
-
*
|
|
8436
|
-
*
|
|
8437
|
-
*
|
|
8405
|
+
* A location locates itself; a name resolves to where it is - a URN under
|
|
8406
|
+
* the process working directory, an Amazon S3 ARN to the `s3:` URL its
|
|
8407
|
+
* bucket and key address - which is what lets any identifier be handed to
|
|
8408
|
+
* a reader as the thing to open.
|
|
8438
8409
|
*/
|
|
8439
|
-
|
|
8440
|
-
/**
|
|
8441
|
-
|
|
8442
|
-
/** Normalized, non-empty
|
|
8410
|
+
locator(): JsUrl
|
|
8411
|
+
/** Decode this file URI as a host-independent forward-slash path. */
|
|
8412
|
+
intoPath(): string
|
|
8413
|
+
/** Normalized, non-empty URI scheme. */
|
|
8443
8414
|
get scheme(): string
|
|
8444
|
-
/** Normalized
|
|
8415
|
+
/** Normalized URI authority, empty when the URI has no authority. */
|
|
8445
8416
|
get authority(): string
|
|
8446
|
-
/** User name from
|
|
8417
|
+
/** User name from URI user information. */
|
|
8447
8418
|
get user(): string | null
|
|
8448
8419
|
/** Password after the first user-information colon. */
|
|
8449
8420
|
get password(): string | null
|
|
@@ -8465,7 +8436,7 @@ export declare class Url {
|
|
|
8465
8436
|
get storeEndpoint(): string | null
|
|
8466
8437
|
/** Whether this location writes its container into the hostname. */
|
|
8467
8438
|
isVirtualHosted(): boolean
|
|
8468
|
-
/** Normalized slash-separated
|
|
8439
|
+
/** Normalized slash-separated URI path. */
|
|
8469
8440
|
get path(): string
|
|
8470
8441
|
/** Query text without the leading question mark. */
|
|
8471
8442
|
get query(): string | null
|
|
@@ -8505,6 +8476,29 @@ export declare class Url {
|
|
|
8505
8476
|
get length(): number
|
|
8506
8477
|
/** Return a path segment at an Array-compatible positive or negative index. */
|
|
8507
8478
|
at(index: number): string | null
|
|
8479
|
+
/** Deserialize the native structural JSON representation. */
|
|
8480
|
+
static fromJSON(value: any): Uri
|
|
8481
|
+
/** Exact normalized native equality. */
|
|
8482
|
+
equals(other: Uri): boolean
|
|
8483
|
+
/** Total native ordering: `-1`, `0`, or `1`. */
|
|
8484
|
+
compare(other: Uri): number
|
|
8485
|
+
/** Deterministic XXH3-64 hash of the canonical URI. */
|
|
8486
|
+
stableHash(): bigint
|
|
8487
|
+
/** Make a cheap native clone. */
|
|
8488
|
+
clone(): Uri
|
|
8489
|
+
/** Return canonical syntax accepted losslessly by `fromString`. */
|
|
8490
|
+
toString(): string
|
|
8491
|
+
/** Serialize to version-independent structural JSON. */
|
|
8492
|
+
toJSON(): any
|
|
8493
|
+
}
|
|
8494
|
+
export type JsUri = Uri
|
|
8495
|
+
|
|
8496
|
+
/** A normalized hierarchical URL backed by the validated Rust core. */
|
|
8497
|
+
export declare class Url {
|
|
8498
|
+
/** Parse/convert a `Url`, any identifier naming one, or location text. */
|
|
8499
|
+
constructor(value: Url | Uri | JsUrn | JsArn | string)
|
|
8500
|
+
/** Infer a URL from any native identifier wrapper or location text. */
|
|
8501
|
+
static from(value: Url | Uri | JsUrn | JsArn | string): Url
|
|
8508
8502
|
/**
|
|
8509
8503
|
* The location this identifier names, as a `Url`.
|
|
8510
8504
|
*
|
|
@@ -8514,8 +8508,6 @@ export declare class Url {
|
|
|
8514
8508
|
* of each and is handed the thing to open.
|
|
8515
8509
|
*/
|
|
8516
8510
|
locator(): Url
|
|
8517
|
-
/** Convert this URL to its general URI representation. */
|
|
8518
|
-
intoUri(): Uri
|
|
8519
8511
|
/** The final path component, as `path.basename`. */
|
|
8520
8512
|
get name(): string
|
|
8521
8513
|
/** The final extension with its leading dot, as `path.extname`. */
|
|
@@ -8582,6 +8574,90 @@ export declare class Url {
|
|
|
8582
8574
|
get partitions(): Array<PartitionEntry>
|
|
8583
8575
|
/** The value of one Hive partition column, when the path has it. */
|
|
8584
8576
|
partition(column: string): string | null
|
|
8577
|
+
/** Parse and validate a hierarchical URL. */
|
|
8578
|
+
static fromString(value: string): Url
|
|
8579
|
+
/** Convert a local, Windows-drive, or UNC path into a normalized file URL. */
|
|
8580
|
+
static fromPath(value: string): Url
|
|
8581
|
+
/** Decode this file URL as a host-independent forward-slash path. */
|
|
8582
|
+
intoPath(): string
|
|
8583
|
+
/**
|
|
8584
|
+
* Validate and convert any identifier, or URI text, into a URL.
|
|
8585
|
+
*
|
|
8586
|
+
* This is the strict door: it answers the URL an identifier already is,
|
|
8587
|
+
* and refuses a name rather than resolving it the way the constructor
|
|
8588
|
+
* does - so a URN refused here is refused in the core's own words.
|
|
8589
|
+
*/
|
|
8590
|
+
static fromUri(value: Uri | Url | JsUrn | JsArn | string): Url
|
|
8591
|
+
/** Normalized, non-empty URL scheme. */
|
|
8592
|
+
get scheme(): string
|
|
8593
|
+
/** Normalized URL authority, empty for a local file URL. */
|
|
8594
|
+
get authority(): string
|
|
8595
|
+
/** User name from URL user information. */
|
|
8596
|
+
get user(): string | null
|
|
8597
|
+
/** Password after the first user-information colon. */
|
|
8598
|
+
get password(): string | null
|
|
8599
|
+
/** Network hostname under the core store-aware rules. */
|
|
8600
|
+
get hostname(): string | null
|
|
8601
|
+
/**
|
|
8602
|
+
* Container name - a bucket on Amazon S3 and Google, a container on
|
|
8603
|
+
* Azure, a table bucket on Amazon S3 Tables - or `null` for a scheme that
|
|
8604
|
+
* names no store.
|
|
8605
|
+
*/
|
|
8606
|
+
get bucket(): string | null
|
|
8607
|
+
/** Azure storage account this location names, when it names one. */
|
|
8608
|
+
get account(): string | null
|
|
8609
|
+
/** Object key: the path below the container, as the path spells it. */
|
|
8610
|
+
get key(): string | null
|
|
8611
|
+
/** Region inferred from a recognized store hostname. */
|
|
8612
|
+
get region(): string | null
|
|
8613
|
+
/** Store endpoint host with its explicit port, without a virtual container. */
|
|
8614
|
+
get storeEndpoint(): string | null
|
|
8615
|
+
/** Whether this location writes its container into the hostname. */
|
|
8616
|
+
isVirtualHosted(): boolean
|
|
8617
|
+
/** Normalized slash-separated URL path. */
|
|
8618
|
+
get path(): string
|
|
8619
|
+
/** Query text without the leading question mark. */
|
|
8620
|
+
get query(): string | null
|
|
8621
|
+
/** Fragment text without the leading hash mark. */
|
|
8622
|
+
get fragment(): string | null
|
|
8623
|
+
/** Last non-empty path segment. */
|
|
8624
|
+
get fileName(): string | null
|
|
8625
|
+
/** Filename without its final non-empty extension. */
|
|
8626
|
+
get stem(): string | null
|
|
8627
|
+
/** Final filename extension without a leading dot. */
|
|
8628
|
+
get extension(): string | null
|
|
8629
|
+
/** All filename extensions in lexical order from left to right. */
|
|
8630
|
+
get extensions(): Array<string>
|
|
8631
|
+
/** Replace the final filename segment or append one to a directory path. */
|
|
8632
|
+
setFileName(value: string): void
|
|
8633
|
+
/** Replace the filename stem while preserving its final extension. */
|
|
8634
|
+
setStem(value: string): void
|
|
8635
|
+
/** Add or replace the final filename extension. */
|
|
8636
|
+
setExtension(value: string): void
|
|
8637
|
+
/** Replace the complete compound filename extension chain. */
|
|
8638
|
+
setExtensions(values: Array<string>): void
|
|
8639
|
+
/** Remove the final filename extension. */
|
|
8640
|
+
removeExtension(): boolean
|
|
8641
|
+
/** Remove every filename extension. */
|
|
8642
|
+
clearExtensions(): boolean
|
|
8643
|
+
/** MIME type inferred from the final suffix. */
|
|
8644
|
+
get mimeType(): MimeType
|
|
8645
|
+
/** Base MIME type and transparent encodings inferred from all suffixes. */
|
|
8646
|
+
get mediaType(): MediaType
|
|
8647
|
+
/** Replace the final suffix using a MIME preferred extension. */
|
|
8648
|
+
setMimeType(value: MimeTypeInput): void
|
|
8649
|
+
/** Replace the full suffix chain using a media type. */
|
|
8650
|
+
setMediaType(value: MediaTypeInput): void
|
|
8651
|
+
/** Non-empty path segments in path order. */
|
|
8652
|
+
get pathSegments(): Array<string>
|
|
8653
|
+
/** Number of path segments exposed through iteration. */
|
|
8654
|
+
get length(): number
|
|
8655
|
+
/** Return a path segment at an Array-compatible positive or negative index. */
|
|
8656
|
+
at(index: number): string | null
|
|
8657
|
+
/** Convert this URL to its general URI representation. */
|
|
8658
|
+
intoUri(): Uri
|
|
8659
|
+
/** Deserialize the native structural JSON representation. */
|
|
8660
|
+
static fromJSON(value: any): Url
|
|
8585
8661
|
/** Exact normalized native equality. */
|
|
8586
8662
|
equals(other: Url): boolean
|
|
8587
8663
|
/** Total native ordering: `-1`, `0`, or `1`. */
|
|
@@ -8603,6 +8679,25 @@ export declare class Urn {
|
|
|
8603
8679
|
constructor(value: Urn | Uri | Url | JsArn | string)
|
|
8604
8680
|
/** Infer a URN from a native URN/URI wrapper or string. */
|
|
8605
8681
|
static from(value: Urn | Uri | Url | JsArn | string): Urn
|
|
8682
|
+
/** Normalized URN namespace identifier. */
|
|
8683
|
+
get namespace(): string
|
|
8684
|
+
/** Namespace-specific string. */
|
|
8685
|
+
get namespaceSpecific(): string
|
|
8686
|
+
/**
|
|
8687
|
+
* The relative path this name spells.
|
|
8688
|
+
*
|
|
8689
|
+
* The namespace leads it and the namespace-specific string's `:`
|
|
8690
|
+
* separators are the ones after it, so `urn:lake:trades:2026:part.parquet`
|
|
8691
|
+
* spells `lake/trades/2026/part.parquet`.
|
|
8692
|
+
*/
|
|
8693
|
+
locatorPath(): string
|
|
8694
|
+
/**
|
|
8695
|
+
* Resolve this name under `base`, answering where it is.
|
|
8696
|
+
*
|
|
8697
|
+
* The path `locatorPath` spells is joined onto `base`, so one base turns a
|
|
8698
|
+
* whole namespace of names into locations without either being rewritten.
|
|
8699
|
+
*/
|
|
8700
|
+
resolve(base: Url | Uri | Urn | JsArn | string): Url
|
|
8606
8701
|
/** Parse and validate a URN. */
|
|
8607
8702
|
static fromString(value: string): Urn
|
|
8608
8703
|
/**
|
|
@@ -8611,9 +8706,7 @@ export declare class Urn {
|
|
|
8611
8706
|
* The strict door, exactly as `Url.fromUri` is: what is not a URN is
|
|
8612
8707
|
* refused in the core's own words rather than converted.
|
|
8613
8708
|
*/
|
|
8614
|
-
static fromUri(value:
|
|
8615
|
-
/** Deserialize the native structural JSON representation. */
|
|
8616
|
-
static fromJSON(value: any): Urn
|
|
8709
|
+
static fromUri(value: Uri | Url | Urn | JsArn | string): Urn
|
|
8617
8710
|
/** The fixed lowercase `urn` scheme. */
|
|
8618
8711
|
get scheme(): string
|
|
8619
8712
|
/** URN authority, which is canonically empty. */
|
|
@@ -8658,25 +8751,6 @@ export declare class Urn {
|
|
|
8658
8751
|
get length(): number
|
|
8659
8752
|
/** Return a path segment at an Array-compatible positive or negative index. */
|
|
8660
8753
|
at(index: number): string | null
|
|
8661
|
-
/** Normalized URN namespace identifier. */
|
|
8662
|
-
get namespace(): string
|
|
8663
|
-
/** Namespace-specific string. */
|
|
8664
|
-
get namespaceSpecific(): string
|
|
8665
|
-
/**
|
|
8666
|
-
* The relative path this name spells.
|
|
8667
|
-
*
|
|
8668
|
-
* The namespace leads it and the namespace-specific string's `:`
|
|
8669
|
-
* separators are the ones after it, so `urn:lake:trades:2026:part.parquet`
|
|
8670
|
-
* spells `lake/trades/2026/part.parquet`.
|
|
8671
|
-
*/
|
|
8672
|
-
locatorPath(): string
|
|
8673
|
-
/**
|
|
8674
|
-
* Resolve this name under `base`, answering where it is.
|
|
8675
|
-
*
|
|
8676
|
-
* The path `locatorPath` spells is joined onto `base`, so one base turns a
|
|
8677
|
-
* whole namespace of names into locations without either being rewritten.
|
|
8678
|
-
*/
|
|
8679
|
-
resolve(base: Url | Uri | Urn | JsArn | string): Url
|
|
8680
8754
|
/**
|
|
8681
8755
|
* Resolve this name under the process working directory.
|
|
8682
8756
|
*
|
|
@@ -8687,6 +8761,8 @@ export declare class Urn {
|
|
|
8687
8761
|
locator(): Url
|
|
8688
8762
|
/** Convert this URN to its general URI representation. */
|
|
8689
8763
|
intoUri(): Uri
|
|
8764
|
+
/** Deserialize the native structural JSON representation. */
|
|
8765
|
+
static fromJSON(value: any): Urn
|
|
8690
8766
|
/** Exact normalized native equality. */
|
|
8691
8767
|
equals(other: Urn): boolean
|
|
8692
8768
|
/** Total native ordering: `-1`, `0`, or `1`. */
|
|
@@ -8721,12 +8797,12 @@ export declare class Version {
|
|
|
8721
8797
|
get minor(): number
|
|
8722
8798
|
/** The patch as text - a number as its digits - or null when none. */
|
|
8723
8799
|
get patch(): string | null
|
|
8800
|
+
/** Deterministic hash bits from the native value. */
|
|
8801
|
+
stableHash(): bigint
|
|
8724
8802
|
/** Compare the complete native values. */
|
|
8725
8803
|
equals(other: Version): boolean
|
|
8726
8804
|
/** Compare native values in canonical order. */
|
|
8727
8805
|
compare(other: Version): number
|
|
8728
|
-
/** Deterministic hash bits from the native value. */
|
|
8729
|
-
stableHash(): bigint
|
|
8730
8806
|
/** Copy the native value. */
|
|
8731
8807
|
clone(): Version
|
|
8732
8808
|
/** Render the canonical native text. */
|
|
@@ -8850,10 +8926,6 @@ export declare class WindowSerie {
|
|
|
8850
8926
|
toString(): string
|
|
8851
8927
|
/** Swap window rows `left` and `right`. */
|
|
8852
8928
|
swap(left: number, right: number): void
|
|
8853
|
-
/** Moves these values into a native scalar-row stream. */
|
|
8854
|
-
intoStream(): StreamSerie
|
|
8855
|
-
/** Moves these values into native chunks under optional row and byte bounds. */
|
|
8856
|
-
intoChunkedStream(rowSize?: number | undefined | null, byteSize?: number | undefined | null): StreamChunkedSerie
|
|
8857
8929
|
}
|
|
8858
8930
|
export type JsWindowSerie = WindowSerie
|
|
8859
8931
|
|
|
@@ -8931,6 +9003,7 @@ export declare class Workbook {
|
|
|
8931
9003
|
}
|
|
8932
9004
|
export type JsWorkbook = Workbook
|
|
8933
9005
|
|
|
9006
|
+
|
|
8934
9007
|
/** A resumable XXH3 state answering 128 bits. */
|
|
8935
9008
|
export declare class Xxh128 {
|
|
8936
9009
|
/** The canonical algorithm token. */
|
|
@@ -9147,6 +9220,19 @@ export interface CodecLimitsInput {
|
|
|
9147
9220
|
/** Parse a format alias and return its stable native spelling. */
|
|
9148
9221
|
export declare function codecNormalizeFormat(format: string): string
|
|
9149
9222
|
|
|
9223
|
+
/**
|
|
9224
|
+
* One member of a core enum the loader builds a JavaScript enum from: its
|
|
9225
|
+
* stored name, the code a column of its kind stores, and what it means.
|
|
9226
|
+
*/
|
|
9227
|
+
export interface EnumMember {
|
|
9228
|
+
/** The member's stored name. */
|
|
9229
|
+
name: string
|
|
9230
|
+
/** The code a column of its kind stores. */
|
|
9231
|
+
code: number
|
|
9232
|
+
/** What the member means. */
|
|
9233
|
+
description: string
|
|
9234
|
+
}
|
|
9235
|
+
|
|
9150
9236
|
/** The grid's bounds and the crate's defaults, for the loader. */
|
|
9151
9237
|
export interface ExcelLimits {
|
|
9152
9238
|
maxRows: number
|
|
@@ -9280,100 +9366,15 @@ export interface FixCode {
|
|
|
9280
9366
|
name: string
|
|
9281
9367
|
/** The venue and per-version spellings that also reach this code. */
|
|
9282
9368
|
aliases?: Array<string>
|
|
9283
|
-
/** The specification's own wording, decoded. */
|
|
9284
|
-
doc?: string
|
|
9285
|
-
/** The group the specification files this code under, decoded. */
|
|
9286
|
-
group?: string
|
|
9287
|
-
/**
|
|
9288
|
-
* The dialects that brought the code, or a spelling of it; absent for
|
|
9289
|
-
* a code the dictionary states of its own, which a fold never renames.
|
|
9290
|
-
*/
|
|
9291
|
-
sources?: Array<string>
|
|
9292
|
-
}
|
|
9293
|
-
|
|
9294
|
-
/** How a codec is pinned, where a caller pins it at all. */
|
|
9295
|
-
export interface FixCodecOptions {
|
|
9296
|
-
/** The byte a numeric frame splits on where the line does not say. */
|
|
9297
|
-
separator?: number
|
|
9298
|
-
/** The batch column a line is read from; `body` when unstated. */
|
|
9299
|
-
payloadColumn?: string
|
|
9300
|
-
/**
|
|
9301
|
-
* What a run's row-header captures are called, in the order a line
|
|
9302
|
-
* answers them.
|
|
9303
|
-
*/
|
|
9304
|
-
captureNames?: Array<string>
|
|
9305
|
-
/** The spellings that mean "nothing was sent". */
|
|
9306
|
-
nullValues?: Array<string>
|
|
9307
|
-
/**
|
|
9308
|
-
* The code of tag 385's set an unmarked line takes on the batch door,
|
|
9309
|
-
* any spelling of one; the core's `Send` code when unstated, no pin
|
|
9310
|
-
* when empty.
|
|
9311
|
-
*/
|
|
9312
|
-
direction?: string
|
|
9313
|
-
/** The raw bytes one Arrow batch targets; the core's 128 MiB when unstated. */
|
|
9314
|
-
batchByteSize?: number
|
|
9315
|
-
/**
|
|
9316
|
-
* The rows one Arrow batch targets; the core's 65,536 when unstated.
|
|
9317
|
-
* A batch closes on whichever bound it reaches first.
|
|
9318
|
-
*/
|
|
9319
|
-
batchRowSize?: number
|
|
9320
|
-
/**
|
|
9321
|
-
* The workers parsing and row conversion use; available CPUs when unstated.
|
|
9322
|
-
* Arrow capture parsing holds at most one input batch per worker and
|
|
9323
|
-
* yields in order; line doors use bounded row chunks. One reads lazily
|
|
9324
|
-
* without a pool, and zero reads as one.
|
|
9325
|
-
*/
|
|
9326
|
-
threads?: number
|
|
9327
|
-
/**
|
|
9328
|
-
* The epoch-aligned lifecycle snapshot width in exact nanoseconds.
|
|
9329
|
-
* `null`, zero and a negative width disable snapshots.
|
|
9330
|
-
*/
|
|
9331
|
-
snapshotNs?: bigint | null
|
|
9332
|
-
/**
|
|
9333
|
-
* Whether the messages `lifecycle` is handed arrive in instant order,
|
|
9334
|
-
* so the walk holds one epoch hour at a time rather than collecting and
|
|
9335
|
-
* sorting the whole capture; `false` when unstated.
|
|
9336
|
-
*/
|
|
9337
|
-
sortedLifecycle?: boolean
|
|
9338
|
-
/**
|
|
9339
|
-
* How far off a whole hour of its log line's clock a stated clock may
|
|
9340
|
-
* stand before it is `clock_skew`, in milliseconds; the core's half
|
|
9341
|
-
* second when unstated. It dates nothing.
|
|
9342
|
-
*/
|
|
9343
|
-
officialTimeDelayMs?: number
|
|
9344
|
-
/**
|
|
9345
|
-
* The message types a parse keeps, spelled as codes or as names -
|
|
9346
|
-
* `"0"`, `"Heartbeat"`, `"unknown"` for a line stating no type. Empty
|
|
9347
|
-
* or unstated keeps every type the refusals leave.
|
|
9348
|
-
*/
|
|
9349
|
-
includeMsgtypes?: Array<string>
|
|
9350
|
-
/**
|
|
9351
|
-
* The message types a parse refuses before it builds a frame; the
|
|
9352
|
-
* core's `Heartbeat`, `TestRequest` and untyped line when unstated, and
|
|
9353
|
-
* an empty list keeps every type.
|
|
9354
|
-
*/
|
|
9355
|
-
excludeMsgtypes?: Array<string>
|
|
9356
|
-
/**
|
|
9357
|
-
* The `SendingTime` an undated message takes when neither it, its row
|
|
9358
|
-
* nor its line dates it: a `DateTime64(ns, UTC)` `Scalar`, or a `Date`
|
|
9359
|
-
* restated in nanoseconds. The Unix epoch per new message when unstated or
|
|
9360
|
-
* `null`.
|
|
9361
|
-
*/
|
|
9362
|
-
defaultSendingTime?: Scalar | Date | null
|
|
9363
|
-
/**
|
|
9364
|
-
* Whether a market operation this codec builds carries, in its
|
|
9365
|
-
* metadata, what its message states that no typed column reads and no
|
|
9366
|
-
* identifier map of the leaf holds, lifting the identifiers among them
|
|
9367
|
-
* into the set their type belongs to - part of the leaf's identity; the
|
|
9368
|
-
* core's `true` when unstated.
|
|
9369
|
-
*/
|
|
9370
|
-
marketMetadata?: boolean
|
|
9369
|
+
/** The specification's own wording, decoded. */
|
|
9370
|
+
doc?: string
|
|
9371
|
+
/** The group the specification files this code under, decoded. */
|
|
9372
|
+
group?: string
|
|
9371
9373
|
/**
|
|
9372
|
-
* The
|
|
9373
|
-
*
|
|
9374
|
-
* once here and refused when the catalog holds no such id.
|
|
9374
|
+
* The dialects that brought the code, or a spelling of it; absent for
|
|
9375
|
+
* a code the dictionary states of its own, which a fold never renames.
|
|
9375
9376
|
*/
|
|
9376
|
-
|
|
9377
|
+
sources?: Array<string>
|
|
9377
9378
|
}
|
|
9378
9379
|
|
|
9379
9380
|
/**
|
|
@@ -9410,11 +9411,11 @@ export interface FixCommitReport {
|
|
|
9410
9411
|
* The definitions this crate owns, in tag order, above every tag FIX or a
|
|
9411
9412
|
* venue publishes.
|
|
9412
9413
|
*
|
|
9413
|
-
* The event's instant `
|
|
9414
|
-
* `
|
|
9415
|
-
* `hashcode`, `crosshashcode`, `uuid`, `crossuuid` and `
|
|
9416
|
-
* the `
|
|
9417
|
-
* `
|
|
9414
|
+
* The event's instant `markettimestamp` and the chain's `creationtimestamp`, `lastexecutiontimestamp`,
|
|
9415
|
+
* `technicaltimestamp`, `previousmarkettimestamp`, `snapshottimestamp` and `expirytimestamp`; the identities
|
|
9416
|
+
* `hashcode`, `crosshashcode`, `uuid`, `crossuuid` and `previousuuid`;
|
|
9417
|
+
* the `sourceuuids` list of the lines it was read from; the `crosscode`, the
|
|
9418
|
+
* `sequencenumber`, the `state` reached and the `previousstate` it followed; the
|
|
9418
9419
|
* `metadata` Map group; what a bridge's capture states - `msgoriginator`,
|
|
9419
9420
|
* `msgeventkey`, the three session names and their kin - and the plugins
|
|
9420
9421
|
* and sessions the message travelled through; the `marketdatakind` the
|
|
@@ -9427,7 +9428,7 @@ export interface FixCommitReport {
|
|
|
9427
9428
|
* bridge's own identifier keys are no crate field either: they arrive as
|
|
9428
9429
|
* unmapped entries and are read for the identifier name they end with.
|
|
9429
9430
|
*
|
|
9430
|
-
* `
|
|
9431
|
+
* `markettimestamp`, `creationtimestamp`, `hashcode`, `crosshashcode`, `uuid` and
|
|
9431
9432
|
* `crossuuid` are non-null; `state` is written on every row a message
|
|
9432
9433
|
* writes and stays nullable, a state having no neutral member. Every
|
|
9433
9434
|
* registry already holds them, so this is the listing a schema or a
|
|
@@ -9469,9 +9470,8 @@ export interface FixEntryView {
|
|
|
9469
9470
|
|
|
9470
9471
|
/**
|
|
9471
9472
|
* The row a rate table stores, `fxrate`: the element and event columns,
|
|
9472
|
-
* `buy`, `sell
|
|
9473
|
-
* `
|
|
9474
|
-
* `["partunix"]`.
|
|
9473
|
+
* `buy`, `sell` and `rate`, declaring `SORT:by` `["crosscode", "markettimestamp"]`
|
|
9474
|
+
* and `PARTITION:by` `["months(markettimestamp)"]` - no column of its own.
|
|
9475
9475
|
*/
|
|
9476
9476
|
export declare function fixFxRateField(): Field
|
|
9477
9477
|
|
|
@@ -9595,7 +9595,7 @@ export interface FixParentSource {
|
|
|
9595
9595
|
/**
|
|
9596
9596
|
* The row of the plugin dictionary, `plugin`: `pluginid`, `name`, `kind`,
|
|
9597
9597
|
* `side` (the side kind's code), `beginstring`, `role`, `hasbackup`,
|
|
9598
|
-
* `parent`, `aliases`, `confighash`, `
|
|
9598
|
+
* `parent`, `aliases`, `confighash`, `firsttimestamp`, `lasttimestamp` and
|
|
9599
9599
|
* `messages`, which `FixPlugins` lays its rows out under.
|
|
9600
9600
|
*/
|
|
9601
9601
|
export declare function fixPluginField(): Field
|
|
@@ -9611,13 +9611,94 @@ export declare function fixPluginSide(pluginType: string): string
|
|
|
9611
9611
|
/**
|
|
9612
9612
|
* The row a FIX dictionary is laid out as, `fixdefinition`: one per scalar
|
|
9613
9613
|
* field, named definition, code set and source, and one for the plugin
|
|
9614
|
-
* dictionary - `category`, `
|
|
9615
|
-
* `
|
|
9616
|
-
*
|
|
9617
|
-
*
|
|
9614
|
+
* dictionary - `category`, `tag`, `name`, `nullable`, `dtype`, `metadata`,
|
|
9615
|
+
* `children` and `document` - keyed by `category`, `tag` and `name`,
|
|
9616
|
+
* declaring `SORT:by` the three and `PARTITION:by` `["category"]`
|
|
9617
|
+
* (`FixRegistry`'s `Registry::row_field`).
|
|
9618
9618
|
*/
|
|
9619
9619
|
export declare function fixRegistryField(): Field
|
|
9620
9620
|
|
|
9621
|
+
/**
|
|
9622
|
+
* One audit report `yggio_market::reports` lists, as the plain object
|
|
9623
|
+
* JavaScript reads: a named plan over the message root, naming no
|
|
9624
|
+
* location.
|
|
9625
|
+
*/
|
|
9626
|
+
export interface FixReport {
|
|
9627
|
+
/** The name a caller asks for the report by. */
|
|
9628
|
+
name: string
|
|
9629
|
+
/** The title a page heads the report with. */
|
|
9630
|
+
title: string
|
|
9631
|
+
/** What the report answers and the regulation it serves. */
|
|
9632
|
+
description: string
|
|
9633
|
+
/**
|
|
9634
|
+
* The plan, naming no location: the engine opens it over the table it
|
|
9635
|
+
* is asked of.
|
|
9636
|
+
*/
|
|
9637
|
+
plan: string
|
|
9638
|
+
/** The parameters the plan binds, in the order its text writes them. */
|
|
9639
|
+
parameters: Array<FixReportParameter>
|
|
9640
|
+
/**
|
|
9641
|
+
* The column holding, per row, the uuids of the messages the row
|
|
9642
|
+
* stands on; absent where the rows name none.
|
|
9643
|
+
*/
|
|
9644
|
+
messages?: string
|
|
9645
|
+
}
|
|
9646
|
+
|
|
9647
|
+
/**
|
|
9648
|
+
* One `:name` parameter an audit report's plan binds, as the plain object
|
|
9649
|
+
* JavaScript reads.
|
|
9650
|
+
*/
|
|
9651
|
+
export interface FixReportParameter {
|
|
9652
|
+
/** The name the plan writes after `:`. */
|
|
9653
|
+
name: string
|
|
9654
|
+
/** What the value is. */
|
|
9655
|
+
description: string
|
|
9656
|
+
/**
|
|
9657
|
+
* The value's text a page binds where the caller states none; absent
|
|
9658
|
+
* where the caller must state it.
|
|
9659
|
+
*/
|
|
9660
|
+
default?: string
|
|
9661
|
+
}
|
|
9662
|
+
|
|
9663
|
+
/**
|
|
9664
|
+
* Every audit report, in the order a page lists them - `otr`, `cancels`,
|
|
9665
|
+
* `rate`, `concentration`, `execution`, `completeness`, `trail` - each a
|
|
9666
|
+
* fresh object: the core's one list, crossing as it is.
|
|
9667
|
+
*/
|
|
9668
|
+
export declare function fixReports(): Array<FixReport>
|
|
9669
|
+
|
|
9670
|
+
/**
|
|
9671
|
+
* One rule `yggio_market::fix::rules` lists, as the plain object
|
|
9672
|
+
* JavaScript reads.
|
|
9673
|
+
*/
|
|
9674
|
+
export interface FixRule {
|
|
9675
|
+
/**
|
|
9676
|
+
* `retired.<tag>`, `der.<tag>`, `def.<tag>`, `read.<fact>`,
|
|
9677
|
+
* `lift.<tag>`, `check.<what>`, `practice.<tag>`, or `der.<name>` for
|
|
9678
|
+
* an audit measure.
|
|
9679
|
+
*/
|
|
9680
|
+
id: string
|
|
9681
|
+
/** What the rule is: its class word. */
|
|
9682
|
+
class: string
|
|
9683
|
+
/** Whose word it is: `spec` or `crate`. */
|
|
9684
|
+
authority: string
|
|
9685
|
+
/** What that authority names. */
|
|
9686
|
+
reference: string
|
|
9687
|
+
/** The tags it reads. */
|
|
9688
|
+
sources: Array<number>
|
|
9689
|
+
/** The tags it fills. */
|
|
9690
|
+
targets: Array<number>
|
|
9691
|
+
/** A `|`-separated FIX line it applies to; `""` where none is kept. */
|
|
9692
|
+
example: string
|
|
9693
|
+
}
|
|
9694
|
+
|
|
9695
|
+
/**
|
|
9696
|
+
* Every rule the crate applies to a FIX message, in the order
|
|
9697
|
+
* `yggio_market::fix::rules` lists them, each a fresh object: the core's
|
|
9698
|
+
* one list, crossing as it is.
|
|
9699
|
+
*/
|
|
9700
|
+
export declare function fixRules(): Array<FixRule>
|
|
9701
|
+
|
|
9621
9702
|
/** What `addSource` records beside the id: each left out states nothing. */
|
|
9622
9703
|
export interface FixSourceOptions {
|
|
9623
9704
|
/**
|
|
@@ -9672,9 +9753,10 @@ export interface FixTimeInForce {
|
|
|
9672
9753
|
/**
|
|
9673
9754
|
* The row an `Underlyings` table stores, `underlying`: one instrument on
|
|
9674
9755
|
* one market, or across every market - the element columns, `code`, `mic`,
|
|
9675
|
-
* `securityids`, the instrument facts, `
|
|
9676
|
-
* `maturityrule`, `issuer` and
|
|
9677
|
-
* `PARTITION:by` `["
|
|
9756
|
+
* `securityids`, the instrument facts, `underlyingcode`, `category`, `timezone`,
|
|
9757
|
+
* `maturityrule`, `issuer`, `aliascodes`, `validtimestamp` and `register`, declaring
|
|
9758
|
+
* `PARTITION:by` `["months(endtimestamp)"]` - a row with no end in the null
|
|
9759
|
+
* partition, no column of its own - and `SORT:by` `["code"]`.
|
|
9678
9760
|
*/
|
|
9679
9761
|
export declare function fixUnderlyingField(): Field
|
|
9680
9762
|
|
|
@@ -10051,17 +10133,6 @@ export interface JoinOptionsInput {
|
|
|
10051
10133
|
pushdownKeys?: number | null
|
|
10052
10134
|
}
|
|
10053
10135
|
|
|
10054
|
-
/**
|
|
10055
|
-
* One member of the core's market data kind enum - FIX's `MsgCat` code set:
|
|
10056
|
-
* its stored name, the code a `marketdatakind` column stores, and what it
|
|
10057
|
-
* means.
|
|
10058
|
-
*/
|
|
10059
|
-
export interface MarketDataKindMember {
|
|
10060
|
-
name: string
|
|
10061
|
-
code: number
|
|
10062
|
-
description: string
|
|
10063
|
-
}
|
|
10064
|
-
|
|
10065
10136
|
/**
|
|
10066
10137
|
* The FIX field and wire value the member `name` stands for, or `null` for
|
|
10067
10138
|
* `UKNW` and a catch-all; throws on a name that is no member.
|
|
@@ -10080,14 +10151,113 @@ export interface MarketDataTypeFixCode {
|
|
|
10080
10151
|
*/
|
|
10081
10152
|
export declare function marketDataTypeFromFix(tag: number, wire: string): string | null
|
|
10082
10153
|
|
|
10083
|
-
/**
|
|
10084
|
-
|
|
10085
|
-
|
|
10086
|
-
|
|
10087
|
-
|
|
10088
|
-
|
|
10089
|
-
|
|
10090
|
-
|
|
10154
|
+
/** How `MarketMessagesOptions` are pinned, where a caller pins them at all. */
|
|
10155
|
+
export interface MarketMessagesOptionsInit {
|
|
10156
|
+
/** The byte a numeric frame splits on where the line does not say. */
|
|
10157
|
+
separator?: number
|
|
10158
|
+
/** The batch column a line is read from; `body` when unstated. */
|
|
10159
|
+
payloadColumn?: string
|
|
10160
|
+
/**
|
|
10161
|
+
* What a run's row-header captures are called, in the order a line
|
|
10162
|
+
* answers them.
|
|
10163
|
+
*/
|
|
10164
|
+
captureNames?: Array<string>
|
|
10165
|
+
/** The spellings that mean "nothing was sent". */
|
|
10166
|
+
nullValues?: Array<string>
|
|
10167
|
+
/**
|
|
10168
|
+
* The code of tag 385's set an unmarked line takes on the batch door,
|
|
10169
|
+
* any spelling of one; the core's `Send` code when unstated, no pin
|
|
10170
|
+
* when empty.
|
|
10171
|
+
*/
|
|
10172
|
+
direction?: string
|
|
10173
|
+
/** The raw bytes one Arrow batch targets; the core's 128 MiB when unstated. */
|
|
10174
|
+
batchByteSize?: number
|
|
10175
|
+
/**
|
|
10176
|
+
* The rows one Arrow batch targets; the core's 65,536 when unstated.
|
|
10177
|
+
* A batch closes on whichever bound it reaches first.
|
|
10178
|
+
*/
|
|
10179
|
+
batchRowSize?: number
|
|
10180
|
+
/**
|
|
10181
|
+
* The workers parsing and row conversion use; available CPUs when unstated.
|
|
10182
|
+
* Arrow capture parsing holds at most one input batch per worker and
|
|
10183
|
+
* yields in order; line doors use bounded row chunks. One reads lazily
|
|
10184
|
+
* without a pool, and zero reads as one.
|
|
10185
|
+
*/
|
|
10186
|
+
threads?: number
|
|
10187
|
+
/**
|
|
10188
|
+
* The epoch-aligned lifecycle snapshot width in exact nanoseconds.
|
|
10189
|
+
* `null`, zero and a negative width disable snapshots.
|
|
10190
|
+
*/
|
|
10191
|
+
snapshotNs?: bigint | null
|
|
10192
|
+
/**
|
|
10193
|
+
* Whether the messages `intoLifecycle` walks arrive in instant order,
|
|
10194
|
+
* so the walk holds one epoch hour at a time rather than collecting and
|
|
10195
|
+
* sorting the whole capture; `false` when unstated.
|
|
10196
|
+
*/
|
|
10197
|
+
sortedLifecycle?: boolean
|
|
10198
|
+
/**
|
|
10199
|
+
* How far off a whole hour of its log line's clock a stated clock may
|
|
10200
|
+
* stand before it is `clock_skew`, in milliseconds; the core's half
|
|
10201
|
+
* second when unstated. It dates nothing.
|
|
10202
|
+
*/
|
|
10203
|
+
officialTimeDelayMs?: number
|
|
10204
|
+
/**
|
|
10205
|
+
* The message types a parse keeps, spelled as codes or as names -
|
|
10206
|
+
* `"0"`, `"Heartbeat"`, `"unknown"` for a line stating no type. Empty
|
|
10207
|
+
* or unstated keeps every type the refusals leave.
|
|
10208
|
+
*/
|
|
10209
|
+
includeMsgtypes?: Array<string>
|
|
10210
|
+
/**
|
|
10211
|
+
* The message types a parse refuses before it builds a frame; the
|
|
10212
|
+
* core's `Heartbeat`, `TestRequest` and untyped line when unstated, and
|
|
10213
|
+
* an empty list keeps every type.
|
|
10214
|
+
*/
|
|
10215
|
+
excludeMsgtypes?: Array<string>
|
|
10216
|
+
/**
|
|
10217
|
+
* The `SendingTime` an undated message takes when neither it, its row
|
|
10218
|
+
* nor its line dates it: a `DateTime64(ns, UTC)` `Scalar`, or a `Date`
|
|
10219
|
+
* restated in nanoseconds. The Unix epoch per new message when unstated or
|
|
10220
|
+
* `null`.
|
|
10221
|
+
*/
|
|
10222
|
+
defaultSendingTime?: Scalar | Date | null
|
|
10223
|
+
/**
|
|
10224
|
+
* Whether a market operation these options build carries, in its
|
|
10225
|
+
* metadata, what its message states that no typed column reads and no
|
|
10226
|
+
* identifier map of the leaf holds, lifting the identifiers among them
|
|
10227
|
+
* into the set their type belongs to - part of the leaf's identity; the
|
|
10228
|
+
* core's `true` when unstated.
|
|
10229
|
+
*/
|
|
10230
|
+
marketMetadata?: boolean
|
|
10231
|
+
/**
|
|
10232
|
+
* The id of the dictionary's source these options read under, folded:
|
|
10233
|
+
* an entry of its sources catalog (`FixRegistry.sources()`), resolved
|
|
10234
|
+
* once here and refused when the catalog holds no such id.
|
|
10235
|
+
*/
|
|
10236
|
+
source?: string
|
|
10237
|
+
}
|
|
10238
|
+
|
|
10239
|
+
/** How `Underlyings.messageSearch` is bounded, where a caller bounds it. */
|
|
10240
|
+
export interface MessageSearchOptions {
|
|
10241
|
+
/**
|
|
10242
|
+
* The dictionary whose plugins give the plugin branch; no plugin
|
|
10243
|
+
* branch when unstated.
|
|
10244
|
+
*/
|
|
10245
|
+
registry?: FixRegistry
|
|
10246
|
+
/**
|
|
10247
|
+
* How many underlying rows the underlying branch names; 20 when
|
|
10248
|
+
* unstated.
|
|
10249
|
+
*/
|
|
10250
|
+
limit?: number
|
|
10251
|
+
/**
|
|
10252
|
+
* The window's first instant on `markettimestamp`, nanoseconds since the
|
|
10253
|
+
* epoch, inclusive.
|
|
10254
|
+
*/
|
|
10255
|
+
since?: bigint | number
|
|
10256
|
+
/**
|
|
10257
|
+
* The window's end on `markettimestamp`, nanoseconds since the epoch,
|
|
10258
|
+
* exclusive.
|
|
10259
|
+
*/
|
|
10260
|
+
until?: bigint | number
|
|
10091
10261
|
}
|
|
10092
10262
|
|
|
10093
10263
|
/** One field-metadata key/value pair. */
|
|
@@ -10151,7 +10321,7 @@ export interface PartitionEntry {
|
|
|
10151
10321
|
}
|
|
10152
10322
|
|
|
10153
10323
|
/**
|
|
10154
|
-
* How `
|
|
10324
|
+
* How `Serie.partitionBy` cuts a lazy serie, each slot `undefined` or
|
|
10155
10325
|
* `null` where not given, which is its default.
|
|
10156
10326
|
*/
|
|
10157
10327
|
export interface PartitionOptionsInput {
|
|
@@ -10249,19 +10419,25 @@ export interface SpillOptionsInit {
|
|
|
10249
10419
|
*/
|
|
10250
10420
|
folder?: IOBase | Url | Uri | Urn | Arn | string | null
|
|
10251
10421
|
/**
|
|
10252
|
-
* What
|
|
10253
|
-
*
|
|
10254
|
-
*
|
|
10422
|
+
* What the process may keep resident - every holder and every serie a
|
|
10423
|
+
* caller keeps - before its holders are pressed: a whole `number` or a
|
|
10424
|
+
* `bigint`; `SpillOptions.NEVER` caps nothing and `0` everything.
|
|
10425
|
+
* `SpillOptions.NEVER` when unstated.
|
|
10255
10426
|
*/
|
|
10256
10427
|
budget?: number | bigint | null
|
|
10257
10428
|
}
|
|
10258
10429
|
|
|
10259
10430
|
/**
|
|
10260
|
-
* What the process
|
|
10261
|
-
*
|
|
10431
|
+
* What the process keeps resident now and kept at most, and what spilling
|
|
10432
|
+
* wrote: the process ledger, read once per count.
|
|
10262
10433
|
*/
|
|
10263
10434
|
export interface SpillStats {
|
|
10264
|
-
/**
|
|
10435
|
+
/**
|
|
10436
|
+
* Bytes the process keeps resident in memory right now: every
|
|
10437
|
+
* allocation of the crate's own, or Arrow's made for it, counted once
|
|
10438
|
+
* however many columns share it, and the native state its holders
|
|
10439
|
+
* reserve.
|
|
10440
|
+
*/
|
|
10265
10441
|
resident: bigint
|
|
10266
10442
|
/** The highest `resident` this process has reached. */
|
|
10267
10443
|
peak: bigint
|
|
@@ -10351,16 +10527,6 @@ export declare function timeInForceFixCode(name: string): string | null
|
|
|
10351
10527
|
*/
|
|
10352
10528
|
export declare function timeInForceFromFix(wire: string): string
|
|
10353
10529
|
|
|
10354
|
-
/**
|
|
10355
|
-
* One member of the core's time-in-force enum: its stored name, the code a
|
|
10356
|
-
* `timeinforce` column stores, and what it means.
|
|
10357
|
-
*/
|
|
10358
|
-
export interface TimeInForceMember {
|
|
10359
|
-
name: string
|
|
10360
|
-
code: number
|
|
10361
|
-
description: string
|
|
10362
|
-
}
|
|
10363
|
-
|
|
10364
10530
|
/** One alias and the canonical name it resolves to. */
|
|
10365
10531
|
export interface TimezoneAlias {
|
|
10366
10532
|
/** The name a caller may write. */
|
|
@@ -10378,22 +10544,26 @@ export declare namespace ai {
|
|
|
10378
10544
|
/**
|
|
10379
10545
|
* An agent of the caller's own: `{ llm, system?, tools?, call(toolUse),
|
|
10380
10546
|
* maxTurns? }`, `call` answering each tool call, `{ id, name, input }`,
|
|
10381
|
-
* with a text or `{ content, is_error }`. `call` is called on this
|
|
10382
|
-
* run; what it throws
|
|
10547
|
+
* with a text or `{ content, is_error }`. `call` is called on this
|
|
10548
|
+
* thread while the run waits for it; what it throws rejects the run.
|
|
10383
10549
|
*/
|
|
10384
10550
|
static fromValue(value: { llm: Llm; system?: string; tools?: Array<{ name: string; description: string; input_schema: object }>; call(toolUse: { id: string; name: string; input: any }): string | { content: string; is_error?: boolean }; maxTurns?: number }): Agent
|
|
10385
10551
|
/**
|
|
10386
|
-
*
|
|
10387
|
-
* `Reply`, every turn appended to
|
|
10552
|
+
* The promise of the run of the conversation until the model ends its
|
|
10553
|
+
* turn, on a worker thread: the final `Reply`, every turn appended to
|
|
10554
|
+
* `messages` in place once it settles. A second run waits for this one.
|
|
10555
|
+
*/
|
|
10556
|
+
run(messages: Array<object>): Promise<Reply>
|
|
10557
|
+
/**
|
|
10558
|
+
* `run`, each step reported to `onEvent` as it happens, every step
|
|
10559
|
+
* before the promise settles; what `onEvent` throws rejects it.
|
|
10388
10560
|
*/
|
|
10389
|
-
|
|
10390
|
-
/** `run`, each step reported to `onEvent` as it happens. */
|
|
10391
|
-
runWith(messages: Array<object>, onEvent: (event: AgentEvent) => void): ai.Reply
|
|
10561
|
+
runWith(messages: Array<object>, onEvent: (event: AgentEvent) => void): Promise<Reply>
|
|
10392
10562
|
}
|
|
10393
10563
|
export type JsAgent = Agent
|
|
10394
10564
|
/**
|
|
10395
|
-
* Where a model is called: Anthropic's API, Amazon Bedrock, Moonshot's API
|
|
10396
|
-
* or this machine.
|
|
10565
|
+
* Where a model is called: Anthropic's API, Amazon Bedrock, Moonshot's API,
|
|
10566
|
+
* an OpenAI-compatible API or this machine.
|
|
10397
10567
|
*/
|
|
10398
10568
|
export class Backend {
|
|
10399
10569
|
/** Anthropic's API under `apiKey`. */
|
|
@@ -10405,14 +10575,38 @@ export declare namespace ai {
|
|
|
10405
10575
|
static bedrock(options?: ai.BedrockInit | undefined | null): Backend
|
|
10406
10576
|
/** Moonshot's Anthropic-compatible API under `apiKey`. */
|
|
10407
10577
|
static moonshot(apiKey: string): Backend
|
|
10578
|
+
/**
|
|
10579
|
+
* An OpenAI-compatible Chat Completions API at `baseUrl` (its root,
|
|
10580
|
+
* `/chat/completions` appended; `OPENAI_BASE_URL`'s value when left
|
|
10581
|
+
* out): `https://api.openai.com/v1`, the Hugging Face router
|
|
10582
|
+
* (`HUGGINGFACE_BASE_URL`), Ollama (`OLLAMA_BASE_URL`), vLLM,
|
|
10583
|
+
* llama.cpp; under `apiKey`, none for a server that takes none.
|
|
10584
|
+
*/
|
|
10585
|
+
static openai(baseUrl?: string | undefined | null, apiKey?: string | undefined | null): Backend
|
|
10408
10586
|
/**
|
|
10409
10587
|
* Anthropic's API when `ANTHROPIC_API_KEY` is set and not blank, else
|
|
10410
10588
|
* Amazon Bedrock from the default AWS chain.
|
|
10411
10589
|
*/
|
|
10412
10590
|
static fromEnv(): Backend
|
|
10591
|
+
/**
|
|
10592
|
+
* Where `model` - a `Model` or any spelling of one - is called when no
|
|
10593
|
+
* backend is chosen: the API `model.defaultApi()` picks, its key from
|
|
10594
|
+
* the API's variable, Bedrock from the default AWS chain, this machine
|
|
10595
|
+
* from the environment's Hub. An API needing a key the environment
|
|
10596
|
+
* does not hold is refused naming its variable.
|
|
10597
|
+
*/
|
|
10598
|
+
static defaultFor(model: ai.Model | string): Backend
|
|
10599
|
+
/**
|
|
10600
|
+
* The API it calls: `"bedrock"` for Amazon Bedrock, whichever of its
|
|
10601
|
+
* APIs a model then takes.
|
|
10602
|
+
*/
|
|
10603
|
+
get api(): string
|
|
10413
10604
|
/** `model` - a `Model` or any spelling of one - as an `Llm` here. */
|
|
10414
10605
|
llm(model: ai.Model | string): ai.Llm
|
|
10415
|
-
/**
|
|
10606
|
+
/**
|
|
10607
|
+
* The backend with no credential in it: `Anthropic(<redacted>)`,
|
|
10608
|
+
* `OpenAi { base_url: "...", key: Some("<redacted>") }`.
|
|
10609
|
+
*/
|
|
10416
10610
|
toString(): string
|
|
10417
10611
|
}
|
|
10418
10612
|
export type JsBackend = Backend
|
|
@@ -10454,18 +10648,27 @@ export declare namespace ai {
|
|
|
10454
10648
|
/** `llm` working through `toolkit`, which the coder takes. */
|
|
10455
10649
|
constructor(llm: ai.Llm, toolkit: ai.Toolkit, options?: ai.CoderInit | undefined | null)
|
|
10456
10650
|
/**
|
|
10457
|
-
*
|
|
10458
|
-
* `Reply`, every turn appended to
|
|
10459
|
-
*
|
|
10651
|
+
* The promise of the run of the conversation until the model ends its
|
|
10652
|
+
* turn, on a worker thread: the final `Reply`, every turn appended to
|
|
10653
|
+
* `messages` in place once it settles. A second run waits for this one.
|
|
10654
|
+
*/
|
|
10655
|
+
run(messages: Array<object>): Promise<Reply>
|
|
10656
|
+
/**
|
|
10657
|
+
* `run`, each step reported to `onEvent` as it happens, every step
|
|
10658
|
+
* before the promise settles; what `onEvent` throws rejects it.
|
|
10460
10659
|
*/
|
|
10461
|
-
|
|
10462
|
-
/**
|
|
10463
|
-
runWith(messages: Array<object>, onEvent: (event: AgentEvent) => void): ai.Reply
|
|
10464
|
-
/** The tools it answers through. */
|
|
10660
|
+
runWith(messages: Array<object>, onEvent: (event: AgentEvent) => void): Promise<Reply>
|
|
10661
|
+
/** The tools it answers through; refused while a run holds the coder. */
|
|
10465
10662
|
get tools(): Array<{ name: string; description: string; input_schema: object }>
|
|
10466
|
-
/**
|
|
10663
|
+
/**
|
|
10664
|
+
* The permissions its toolkit runs calls under; refused while a run
|
|
10665
|
+
* holds the coder.
|
|
10666
|
+
*/
|
|
10467
10667
|
get permissions(): string
|
|
10468
|
-
/**
|
|
10668
|
+
/**
|
|
10669
|
+
* Run every later call under `permissions`; refused while a run holds
|
|
10670
|
+
* the coder.
|
|
10671
|
+
*/
|
|
10469
10672
|
set permissions(permissions: string)
|
|
10470
10673
|
}
|
|
10471
10674
|
export type JsCoder = Coder
|
|
@@ -10473,18 +10676,23 @@ export declare namespace ai {
|
|
|
10473
10676
|
export class Distiller {
|
|
10474
10677
|
/** `student` taught by `teacher`; both stay usable by the caller. */
|
|
10475
10678
|
constructor(teacher: JsLlm, student: JsLlm, options?: ai.DistillerOptions | undefined | null)
|
|
10476
|
-
/** The teacher's answer to each of `prompts`, in order. */
|
|
10477
|
-
examples(prompts: Array<string>): Array<ai.Example>
|
|
10478
10679
|
/**
|
|
10479
|
-
* The
|
|
10480
|
-
*
|
|
10680
|
+
* The promise of the teacher's answer to each of `prompts`, in order,
|
|
10681
|
+
* asked on a worker thread.
|
|
10481
10682
|
*/
|
|
10482
|
-
|
|
10683
|
+
examples(prompts: Array<string>): Promise<Array<Example>>
|
|
10483
10684
|
/**
|
|
10484
|
-
*
|
|
10485
|
-
* the
|
|
10685
|
+
* The promise of the student's answer to each example under `system`
|
|
10686
|
+
* (none when not given), graded against the teacher's, on a worker
|
|
10687
|
+
* thread.
|
|
10486
10688
|
*/
|
|
10487
|
-
|
|
10689
|
+
evaluate(examples: Array<ai.Example>, system?: string | undefined | null): Promise<Report>
|
|
10690
|
+
/**
|
|
10691
|
+
* The promise of up to `rounds` rounds of system-prompt optimization,
|
|
10692
|
+
* each kept when the student scores better under it, on a worker
|
|
10693
|
+
* thread.
|
|
10694
|
+
*/
|
|
10695
|
+
refine(examples: Array<ai.Example>, rounds: number): Promise<Refinement>
|
|
10488
10696
|
}
|
|
10489
10697
|
export type JsDistiller = Distiller
|
|
10490
10698
|
/** A prompt and the teacher's answer to it. */
|
|
@@ -10509,18 +10717,18 @@ export declare namespace ai {
|
|
|
10509
10717
|
constructor(options?: ai.HubOptions | undefined | null)
|
|
10510
10718
|
/** The cache folder. */
|
|
10511
10719
|
get cache(): string
|
|
10512
|
-
/**
|
|
10513
|
-
info(repo: string):
|
|
10720
|
+
/** The promise of what the Hub states about `repo`: one request. */
|
|
10721
|
+
info(repo: string): Promise<RepoInfo>
|
|
10514
10722
|
/**
|
|
10515
|
-
* The local path of `file` of `repo` at its default
|
|
10516
|
-
* into the cache unless it is there.
|
|
10723
|
+
* The promise of the local path of `file` of `repo` at its default
|
|
10724
|
+
* revision, fetched into the cache unless it is there.
|
|
10517
10725
|
*/
|
|
10518
|
-
file(repo: string, file: string): string
|
|
10726
|
+
file(repo: string, file: string): Promise<string>
|
|
10519
10727
|
/**
|
|
10520
|
-
* The local path of `file` of `repo` at `revision`,
|
|
10521
|
-
* cache unless it is there.
|
|
10728
|
+
* The promise of the local path of `file` of `repo` at `revision`,
|
|
10729
|
+
* fetched into the cache unless it is there.
|
|
10522
10730
|
*/
|
|
10523
|
-
fileAt(repo: string, revision: string, file: string): string
|
|
10731
|
+
fileAt(repo: string, revision: string, file: string): Promise<string>
|
|
10524
10732
|
/**
|
|
10525
10733
|
* The cached path of `file` of `repo` at `revision`; `null` when the
|
|
10526
10734
|
* cache does not hold it. Fetches nothing.
|
|
@@ -10580,12 +10788,28 @@ export declare namespace ai {
|
|
|
10580
10788
|
static bedrock(model?: JsModel | string | undefined | null, options?: BedrockInit | undefined | null): Llm
|
|
10581
10789
|
/** Kimi from Moonshot's Anthropic-compatible API under `apiKey`. */
|
|
10582
10790
|
static moonshot(apiKey: string, options?: ai.MoonshotInit | undefined | null): Llm
|
|
10791
|
+
/**
|
|
10792
|
+
* `model` on an OpenAI-compatible Chat Completions API: the one at
|
|
10793
|
+
* `https://api.openai.com/v1` unless `options` names another root,
|
|
10794
|
+
* under the key it states.
|
|
10795
|
+
*/
|
|
10796
|
+
static openai(model: JsModel | string, options?: ai.OpenAiInit | undefined | null): Llm
|
|
10797
|
+
/**
|
|
10798
|
+
* `model` on the Hugging Face inference router
|
|
10799
|
+
* (`HUGGINGFACE_BASE_URL`) under the Hub token `token`.
|
|
10800
|
+
*/
|
|
10801
|
+
static huggingface(token: string, model: JsModel | string): Llm
|
|
10802
|
+
/**
|
|
10803
|
+
* `model` on the Ollama server on this machine (`OLLAMA_BASE_URL`),
|
|
10804
|
+
* which takes no key.
|
|
10805
|
+
*/
|
|
10806
|
+
static ollama(model: JsModel | string): Llm
|
|
10583
10807
|
/**
|
|
10584
10808
|
* A model of the caller's own: `{ model, complete(request) }`, where
|
|
10585
10809
|
* `model` is a `Model` or a model name and `complete` answers an
|
|
10586
10810
|
* `LlmRequest` with a `Reply`, a text, or a Messages API message object.
|
|
10587
|
-
* `complete` is called on this thread
|
|
10588
|
-
* model; what it throws
|
|
10811
|
+
* `complete` is called on this thread, while the door that asks the
|
|
10812
|
+
* model waits for it; what it throws rejects that door. A value with no
|
|
10589
10813
|
* `model` is refused with a `TypeError` naming the member.
|
|
10590
10814
|
*/
|
|
10591
10815
|
static fromValue(value: { model: Model | string; complete(request: LlmRequest): Reply | string | object }): Llm
|
|
@@ -10599,15 +10823,17 @@ export declare namespace ai {
|
|
|
10599
10823
|
/** The model it asks. */
|
|
10600
10824
|
get model(): JsModel
|
|
10601
10825
|
/**
|
|
10602
|
-
*
|
|
10603
|
-
*
|
|
10826
|
+
* The promise of the whole answer to `request` - an `LlmRequest`, or a
|
|
10827
|
+
* text as one user message - the model asked on a worker thread.
|
|
10604
10828
|
*/
|
|
10605
|
-
complete(request: JsRequest | string):
|
|
10829
|
+
complete(request: JsRequest | string): Promise<Reply>
|
|
10606
10830
|
/**
|
|
10607
|
-
*
|
|
10608
|
-
*
|
|
10831
|
+
* `complete`, calling `onText` with each piece of text as the model
|
|
10832
|
+
* writes it, every piece before the promise settles; the same
|
|
10833
|
+
* accumulated `Reply`. What `onText` throws rejects the promise, the
|
|
10834
|
+
* later pieces not reported.
|
|
10609
10835
|
*/
|
|
10610
|
-
stream(request: JsRequest | string, onText: (arg: string) => void):
|
|
10836
|
+
stream(request: JsRequest | string, onText: (arg: string) => void): Promise<Reply>
|
|
10611
10837
|
/**
|
|
10612
10838
|
* The variant and the model's identifier, never a credential:
|
|
10613
10839
|
* `Claude("claude-opus-5-5")`.
|
|
@@ -10708,9 +10934,17 @@ export declare namespace ai {
|
|
|
10708
10934
|
/**
|
|
10709
10935
|
* The identifier `api` names the model by; `null` where `api` does not
|
|
10710
10936
|
* serve it. `api` is one of `anthropic`, `bedrock`, `converse`,
|
|
10711
|
-
* `local`, `moonshot`.
|
|
10937
|
+
* `local`, `moonshot`, `openai`.
|
|
10712
10938
|
*/
|
|
10713
10939
|
apiId(api: string): string | null
|
|
10940
|
+
/**
|
|
10941
|
+
* The API the model is called on when none is chosen (`Api::default_for`):
|
|
10942
|
+
* `"local"` where this build and the model have it, else Anthropic's
|
|
10943
|
+
* or Moonshot's where the environment holds its key, else `"bedrock"`
|
|
10944
|
+
* where Bedrock serves it, else the first API serving it; never
|
|
10945
|
+
* `"openai"`, which is only ever chosen.
|
|
10946
|
+
*/
|
|
10947
|
+
defaultApi(): string
|
|
10714
10948
|
/**
|
|
10715
10949
|
* The `max_tokens` a request asking `asked` sends: `asked`, at most
|
|
10716
10950
|
* what the model writes.
|
|
@@ -10761,6 +10995,11 @@ export declare namespace ai {
|
|
|
10761
10995
|
* the store's properties, each value text, a number or a boolean.
|
|
10762
10996
|
*/
|
|
10763
10997
|
constructor(location: string, properties?: object | undefined | null)
|
|
10998
|
+
/**
|
|
10999
|
+
* The location a store is kept at when none is named:
|
|
11000
|
+
* `$YGGIO_AI_STORE`, else `~/.cache/yggio/models`.
|
|
11001
|
+
*/
|
|
11002
|
+
static defaultRoot(): string
|
|
10764
11003
|
/** The folder remote files are materialized in. */
|
|
10765
11004
|
get cache(): string
|
|
10766
11005
|
/**
|
|
@@ -10849,8 +11088,9 @@ export declare namespace ai {
|
|
|
10849
11088
|
/** Every one of `routes` matches. */
|
|
10850
11089
|
static all(routes: Array<ai.Route>): Route
|
|
10851
11090
|
/**
|
|
10852
|
-
* `predicate(request)` holds. It is called on this thread
|
|
10853
|
-
* door that routes the request; what it throws is
|
|
11091
|
+
* `predicate(request)` holds. It is called on this thread, while the
|
|
11092
|
+
* door that routes the request waits for it; what it throws is
|
|
11093
|
+
* rethrown - or rejects - from there.
|
|
10854
11094
|
*/
|
|
10855
11095
|
static when(predicate: (arg: JsRequest) => boolean): Route
|
|
10856
11096
|
/** Whether `request` takes this route. */
|
|
@@ -10859,6 +11099,120 @@ export declare namespace ai {
|
|
|
10859
11099
|
toString(): string
|
|
10860
11100
|
}
|
|
10861
11101
|
export type JsRoute = Route
|
|
11102
|
+
/**
|
|
11103
|
+
* What the `ai` namespace is pointed at: the API and model, where the API
|
|
11104
|
+
* answers and under which variable's key, Bedrock's region and profile, the
|
|
11105
|
+
* model store and the Hub.
|
|
11106
|
+
*
|
|
11107
|
+
* `new Settings()` is the defaults - `api` `"local"`, `model`
|
|
11108
|
+
* `"smollm2-135m"`; `Settings.load()` the file at `Settings.path()`.
|
|
11109
|
+
* `set(key, value)` changes one setting from its text, each key read by its
|
|
11110
|
+
* own reader; a refused value leaves the settings as they were.
|
|
11111
|
+
*/
|
|
11112
|
+
export class Settings {
|
|
11113
|
+
/**
|
|
11114
|
+
* The defaults: this machine (`"local"`) and its smallest model
|
|
11115
|
+
* (`"smollm2-135m"`), every other setting the environment's.
|
|
11116
|
+
*/
|
|
11117
|
+
constructor()
|
|
11118
|
+
/**
|
|
11119
|
+
* Where the settings are kept: `$YGGIO_AI_SETTINGS`, else
|
|
11120
|
+
* `$XDG_CONFIG_HOME/yggio/ai.json`, else `~/.config/yggio/ai.json`.
|
|
11121
|
+
*/
|
|
11122
|
+
static path(): string
|
|
11123
|
+
/** The settings at `Settings.path()`; no file there is the defaults. */
|
|
11124
|
+
static load(): Settings
|
|
11125
|
+
/**
|
|
11126
|
+
* The settings in the file at `path`; no file there is the defaults. A
|
|
11127
|
+
* file that is not a settings object - an unknown key, a value of the
|
|
11128
|
+
* wrong kind, a key stored where a variable's name belongs - is refused
|
|
11129
|
+
* naming its path and place.
|
|
11130
|
+
*/
|
|
11131
|
+
static loadFrom(path: string): Settings
|
|
11132
|
+
/** Write the settings to `Settings.path()`, its folder created. */
|
|
11133
|
+
save(): void
|
|
11134
|
+
/**
|
|
11135
|
+
* Write the settings to `path`, its folder created, so a reader sees
|
|
11136
|
+
* the old file or the new one whole.
|
|
11137
|
+
*/
|
|
11138
|
+
saveTo(path: string): void
|
|
11139
|
+
/**
|
|
11140
|
+
* Set the setting `key` - `api`, `model`, `base_url`, `api_key_env`,
|
|
11141
|
+
* `region`, `profile`, `store`, `hub.endpoint`, `hub.cache`,
|
|
11142
|
+
* `hub.offline`, `hub.token_env` - from its text, a boolean as its
|
|
11143
|
+
* text; `null` or an empty text clears an optional one. An unknown key
|
|
11144
|
+
* is refused listing those it holds, a value its reader cannot read is
|
|
11145
|
+
* refused, and the settings are then as they were.
|
|
11146
|
+
*/
|
|
11147
|
+
set(key: string, value: string | boolean | null): void
|
|
11148
|
+
/**
|
|
11149
|
+
* The APIs this build serves: every API, `"local"` only in a build with
|
|
11150
|
+
* feature `local`.
|
|
11151
|
+
*/
|
|
11152
|
+
static available(): Array<string>
|
|
11153
|
+
/** The API models are called on. */
|
|
11154
|
+
get api(): string
|
|
11155
|
+
/** The model, as it was named. */
|
|
11156
|
+
get model(): string
|
|
11157
|
+
/** The API's root, where it is not its own; `null` where none is stated. */
|
|
11158
|
+
get baseUrl(): string | null
|
|
11159
|
+
/**
|
|
11160
|
+
* The name of the environment variable holding the API's key, never
|
|
11161
|
+
* the key; `null` for the API's own.
|
|
11162
|
+
*/
|
|
11163
|
+
get apiKeyEnv(): string | null
|
|
11164
|
+
/** Amazon Bedrock's region, where it is not the AWS session's. */
|
|
11165
|
+
get region(): string | null
|
|
11166
|
+
/** The AWS shared-configuration profile Bedrock signs in under. */
|
|
11167
|
+
get profile(): string | null
|
|
11168
|
+
/** Where local models are kept, as stated; `null` for the default root. */
|
|
11169
|
+
get store(): string | null
|
|
11170
|
+
/** The Hub's root, a mirror; `null` for `HF_ENDPOINT`'s. */
|
|
11171
|
+
get hubEndpoint(): string | null
|
|
11172
|
+
/** The folder Hub files are cached in; `null` for `HF_HUB_CACHE`'s. */
|
|
11173
|
+
get hubCache(): string | null
|
|
11174
|
+
/** Never fetch from the Hub; `false` leaves `HF_HUB_OFFLINE` to decide. */
|
|
11175
|
+
get hubOffline(): boolean
|
|
11176
|
+
/**
|
|
11177
|
+
* The name of the environment variable holding the Hub token; `null`
|
|
11178
|
+
* for `HF_TOKEN`.
|
|
11179
|
+
*/
|
|
11180
|
+
get hubTokenEnv(): string | null
|
|
11181
|
+
/**
|
|
11182
|
+
* The model store's location: `store`, else
|
|
11183
|
+
* `ModelStore.defaultRoot()`.
|
|
11184
|
+
*/
|
|
11185
|
+
get storeLocation(): string
|
|
11186
|
+
/**
|
|
11187
|
+
* The Hub the settings state, the environment's for what they leave
|
|
11188
|
+
* out, reporting each download's `HubProgress` to `onProgress` where
|
|
11189
|
+
* one is given (as `new Hub({ onProgress })` does); nothing is reported
|
|
11190
|
+
* when it is left out or `null`.
|
|
11191
|
+
*/
|
|
11192
|
+
hub(onProgress?: ((progress: HubProgress) => void) | null): ai.Hub
|
|
11193
|
+
/** The model store at `storeLocation`. */
|
|
11194
|
+
modelStore(): JsModelStore
|
|
11195
|
+
/**
|
|
11196
|
+
* Where the model is called: on `api`, except that `"local"` calls a
|
|
11197
|
+
* model this machine cannot run where `Model.defaultApi()` finds it.
|
|
11198
|
+
* An API whose key variable holds none is refused naming the variable,
|
|
11199
|
+
* and `"local"` in a build without it naming what the build serves.
|
|
11200
|
+
*/
|
|
11201
|
+
backend(): ai.Backend
|
|
11202
|
+
/**
|
|
11203
|
+
* The model as an `Llm` on `backend()`, sent to the stated root and on
|
|
11204
|
+
* this machine kept in the stated store. Nothing is called yet.
|
|
11205
|
+
*/
|
|
11206
|
+
llm(): ai.Llm
|
|
11207
|
+
/** Whether `other` states every setting this one does. */
|
|
11208
|
+
equals(other: ai.Settings): boolean
|
|
11209
|
+
/**
|
|
11210
|
+
* The API and the model, never a key: `Settings(api=local,
|
|
11211
|
+
* model=smollm2-135m)`.
|
|
11212
|
+
*/
|
|
11213
|
+
toString(): string
|
|
11214
|
+
}
|
|
11215
|
+
export type JsSettings = Settings
|
|
10862
11216
|
/** Tasks any `Llm` runs, each once. */
|
|
10863
11217
|
export class Suite {
|
|
10864
11218
|
/** The suite of `tasks`, in the order they run. */
|
|
@@ -10868,13 +11222,13 @@ export declare namespace ai {
|
|
|
10868
11222
|
/** How many tasks it holds. */
|
|
10869
11223
|
get length(): number
|
|
10870
11224
|
/**
|
|
10871
|
-
*
|
|
10872
|
-
*
|
|
10873
|
-
* A caller's own `complete` that
|
|
10874
|
-
*
|
|
10875
|
-
*
|
|
11225
|
+
* The promise of `llm` asked each task once, in order, streamed and
|
|
11226
|
+
* timed, on a worker thread: a call that fails is an outcome scoring 0
|
|
11227
|
+
* with its error, and the run goes on. A caller's own `complete` that
|
|
11228
|
+
* throws is such a call: its message is the outcome's error, never
|
|
11229
|
+
* rethrown.
|
|
10876
11230
|
*/
|
|
10877
|
-
run(llm: JsLlm):
|
|
11231
|
+
run(llm: JsLlm): Promise<SuiteReport>
|
|
10878
11232
|
/**
|
|
10879
11233
|
* Per kind of task, the model of `reports` scoring at least `floor` on
|
|
10880
11234
|
* it that cost least over its whole run, the lower mean latency
|
|
@@ -10929,12 +11283,12 @@ export declare namespace ai {
|
|
|
10929
11283
|
/** The tools the model may call, as `{ name, description, input_schema }`. */
|
|
10930
11284
|
get tools(): Array<{ name: string; description: string; input_schema: object }>
|
|
10931
11285
|
/**
|
|
10932
|
-
*
|
|
10933
|
-
* ignored - by the
|
|
10934
|
-
*
|
|
11286
|
+
* The promise of the answer to `toolUse` - a tool call, `{ id, name,
|
|
11287
|
+
* input }`, a `type` key ignored - by the action of its name, when the
|
|
11288
|
+
* permissions allow it, run on a worker thread; a refused call, an
|
|
10935
11289
|
* unknown tool or a bad input is an error result naming why.
|
|
10936
11290
|
*/
|
|
10937
|
-
call(toolUse: { id: string; name: string; input: any }):
|
|
11291
|
+
call(toolUse: { id: string; name: string; input: any }): Promise<ToolResult>
|
|
10938
11292
|
/** The permissions calls run under: `read-only`, `ask` or `auto`. */
|
|
10939
11293
|
get permissions(): string
|
|
10940
11294
|
/** Run every later call under `permissions`. */
|
|
@@ -10966,16 +11320,16 @@ export declare namespace ai {
|
|
|
10966
11320
|
/** The engine a search asks: `"duckduckgo"`, `"brave"` or `"searxng"`. */
|
|
10967
11321
|
get engine(): string
|
|
10968
11322
|
/**
|
|
10969
|
-
* The page at `url`, redirects followed
|
|
10970
|
-
*
|
|
10971
|
-
* cut at the most bytes read.
|
|
11323
|
+
* The promise of the page at `url`, redirects followed, fetched on a
|
|
11324
|
+
* worker thread: HTML read as `htmlToText` reads it against the final
|
|
11325
|
+
* URL, text and JSON as they are, the body cut at the most bytes read.
|
|
10972
11326
|
*/
|
|
10973
|
-
fetch(url: string):
|
|
11327
|
+
fetch(url: string): Promise<Page>
|
|
10974
11328
|
/**
|
|
10975
|
-
*
|
|
10976
|
-
* `query`, in its order
|
|
11329
|
+
* The promise of at most `limit` (10 when not given) results the
|
|
11330
|
+
* engine answers for `query`, in its order, asked on a worker thread.
|
|
10977
11331
|
*/
|
|
10978
|
-
search(query: string, limit?: number | undefined | null): Array<
|
|
11332
|
+
search(query: string, limit?: number | undefined | null): Promise<Array<Hit>>
|
|
10979
11333
|
}
|
|
10980
11334
|
export type JsWeb = Web
|
|
10981
11335
|
/**
|
|
@@ -11034,6 +11388,11 @@ export declare namespace ai {
|
|
|
11034
11388
|
/** The most model turns a run takes; 64 when left out. */
|
|
11035
11389
|
maxTurns?: number | null
|
|
11036
11390
|
}
|
|
11391
|
+
/**
|
|
11392
|
+
* The model `new Settings()` asks: the smallest of the catalog's local
|
|
11393
|
+
* models, `smollm2-135m`.
|
|
11394
|
+
*/
|
|
11395
|
+
export const DEFAULT_LOCAL_MODEL: string
|
|
11037
11396
|
/**
|
|
11038
11397
|
* What a `Distiller` is built with; a knob not given (or `null`) keeps the
|
|
11039
11398
|
* core's default.
|
|
@@ -11083,7 +11442,26 @@ export declare namespace ai {
|
|
|
11083
11442
|
* `HF_HUB_OFFLINE`.
|
|
11084
11443
|
*/
|
|
11085
11444
|
offline?: boolean | null
|
|
11445
|
+
/**
|
|
11446
|
+
* Called with a download's `HubProgress` as its bytes land, on this
|
|
11447
|
+
* thread while the fetch waits for it; what it throws rejects the
|
|
11448
|
+
* fetch. Nothing is reported when left out.
|
|
11449
|
+
*/
|
|
11450
|
+
onProgress?: ((progress: HubProgress) => void) | null
|
|
11451
|
+
}
|
|
11452
|
+
/** What a download reports as its bytes land. */
|
|
11453
|
+
export interface HubProgress {
|
|
11454
|
+
/** The repository, such as `Qwen/Qwen2.5-0.5B-Instruct-GGUF`. */
|
|
11455
|
+
repo: string
|
|
11456
|
+
/** The file within it. */
|
|
11457
|
+
file: string
|
|
11458
|
+
/** Bytes on disk so far, a resumed prefix included. */
|
|
11459
|
+
done: number
|
|
11460
|
+
/** The file's whole length; `null` when the Hub stated none. */
|
|
11461
|
+
total: number | null
|
|
11086
11462
|
}
|
|
11463
|
+
/** The Hugging Face inference router's OpenAI-compatible root. */
|
|
11464
|
+
export const HUGGINGFACE_BASE_URL: string
|
|
11087
11465
|
/** One link of a `Page`. */
|
|
11088
11466
|
export interface Link {
|
|
11089
11467
|
/**
|
|
@@ -11110,6 +11488,8 @@ export declare namespace ai {
|
|
|
11110
11488
|
local?: string | null
|
|
11111
11489
|
/** Moonshot's identifier, or `null`. */
|
|
11112
11490
|
moonshot?: string | null
|
|
11491
|
+
/** An OpenAI-compatible API's identifier, or `null`. */
|
|
11492
|
+
openai?: string | null
|
|
11113
11493
|
/** The other names it goes by. */
|
|
11114
11494
|
aliases?: Array<string> | null
|
|
11115
11495
|
/** The most tokens a request's input may hold. */
|
|
@@ -11133,6 +11513,23 @@ export declare namespace ai {
|
|
|
11133
11513
|
/** The API's root, `/v1/messages` appended. */
|
|
11134
11514
|
baseUrl?: string | null
|
|
11135
11515
|
}
|
|
11516
|
+
/** The OpenAI-compatible root of the Ollama server on this machine. */
|
|
11517
|
+
export const OLLAMA_BASE_URL: string
|
|
11518
|
+
/** `https://api.openai.com/v1`, `Backend.openai`'s and `Llm.openai`'s default root. */
|
|
11519
|
+
export const OPENAI_BASE_URL: string
|
|
11520
|
+
/** An OpenAI-compatible API, as `Llm.openai` takes it. */
|
|
11521
|
+
export interface OpenAiInit {
|
|
11522
|
+
/**
|
|
11523
|
+
* The API's root, `/chat/completions` appended: a self-hosted server,
|
|
11524
|
+
* vLLM, llama.cpp; `OPENAI_BASE_URL`'s value when left out.
|
|
11525
|
+
*/
|
|
11526
|
+
baseUrl?: string | null
|
|
11527
|
+
/**
|
|
11528
|
+
* The API key, sent as a bearer token; none when left out, for a
|
|
11529
|
+
* server that takes none.
|
|
11530
|
+
*/
|
|
11531
|
+
apiKey?: string | null
|
|
11532
|
+
}
|
|
11136
11533
|
/** How one model did on one `Task`. */
|
|
11137
11534
|
export interface Outcome {
|
|
11138
11535
|
/** The task's name. */
|
|
@@ -11319,9 +11716,9 @@ export declare namespace ai {
|
|
|
11319
11716
|
/**
|
|
11320
11717
|
* Asked what `ask` does not allow by itself: `approver(toolUse,
|
|
11321
11718
|
* access)`, `access` one of `read`, `write`, `execute`, `network`,
|
|
11322
|
-
* answering whether the call runs. Called on this thread
|
|
11323
|
-
* door that runs the call; what it throws
|
|
11324
|
-
* Every such call is refused when left out.
|
|
11719
|
+
* answering whether the call runs. Called on this thread while the
|
|
11720
|
+
* door that runs the call waits for it; what it throws rejects that
|
|
11721
|
+
* door. Every such call is refused when left out.
|
|
11325
11722
|
*/
|
|
11326
11723
|
approver?: ((toolUse: { id: string; name: string; input: any }, access: 'read' | 'write' | 'execute' | 'network') => boolean) | null
|
|
11327
11724
|
}
|
|
@@ -11331,3 +11728,96 @@ export declare namespace ai {
|
|
|
11331
11728
|
*/
|
|
11332
11729
|
export function writeJsonl(examples: Array<ai.Example>, path: string): void
|
|
11333
11730
|
}
|
|
11731
|
+
|
|
11732
|
+
export declare namespace distance {
|
|
11733
|
+
/**
|
|
11734
|
+
* The unrestricted Damerau-Levenshtein distance: Levenshtein's edits plus
|
|
11735
|
+
* the transposition of two adjacent characters.
|
|
11736
|
+
*/
|
|
11737
|
+
export function damerauLevenshtein(left: string, right: string): number
|
|
11738
|
+
/** The similarity `matches` takes by default: one edit in four characters. */
|
|
11739
|
+
export const DEFAULT_SIMILARITY: number
|
|
11740
|
+
/** The Jaro similarity, from `0` to `1`. */
|
|
11741
|
+
export function jaroSimilarity(left: string, right: string): number
|
|
11742
|
+
/** The Jaro-Winkler similarity, from `0` to `1`. */
|
|
11743
|
+
export function jaroWinklerSimilarity(left: string, right: string): number
|
|
11744
|
+
/**
|
|
11745
|
+
* The fewest single-character insertions, deletions and substitutions that
|
|
11746
|
+
* turn `left` into `right`, counted over characters, never bytes.
|
|
11747
|
+
*/
|
|
11748
|
+
export function levenshtein(left: string, right: string): number
|
|
11749
|
+
/**
|
|
11750
|
+
* The Levenshtein distance where it is at most `max`, else `null`; `max`
|
|
11751
|
+
* is a non-negative whole number.
|
|
11752
|
+
*/
|
|
11753
|
+
export function levenshteinWithin(left: string, right: string, max: number): number | null
|
|
11754
|
+
/**
|
|
11755
|
+
* One candidate `matches` kept: the text as it was given, its Levenshtein
|
|
11756
|
+
* distance from the needle and its similarity to it, both over the two
|
|
11757
|
+
* normalized forms.
|
|
11758
|
+
*/
|
|
11759
|
+
export interface Matched {
|
|
11760
|
+
/** The candidate, as it was given. */
|
|
11761
|
+
text: string
|
|
11762
|
+
/** The edits between the normalized needle and the normalized candidate. */
|
|
11763
|
+
distance: number
|
|
11764
|
+
/** One less the distance over the longer normalized form's characters. */
|
|
11765
|
+
similarity: number
|
|
11766
|
+
/** Whether the candidate's normalized form is the needle's. */
|
|
11767
|
+
exact: boolean
|
|
11768
|
+
}
|
|
11769
|
+
/**
|
|
11770
|
+
* The candidates at least `threshold` similar to `needle`, both
|
|
11771
|
+
* normalized, at most `limit` of them: exact ones first, then by distance
|
|
11772
|
+
* ascending, similarity descending and input order.
|
|
11773
|
+
*/
|
|
11774
|
+
export function matches(needle: string, candidates: Array<string>, options?: distance.MatchesOptions | undefined | null): Array<distance.Matched>
|
|
11775
|
+
/**
|
|
11776
|
+
* How `matches` ranks: `threshold` the least similarity a candidate keeps
|
|
11777
|
+
* (`DEFAULT_SIMILARITY` when left out), `limit` the most candidates kept
|
|
11778
|
+
* (20 when left out).
|
|
11779
|
+
*/
|
|
11780
|
+
export interface MatchesOptions {
|
|
11781
|
+
/**
|
|
11782
|
+
* The least similarity a candidate keeps; `DEFAULT_SIMILARITY` when
|
|
11783
|
+
* left out or `null`.
|
|
11784
|
+
*/
|
|
11785
|
+
threshold?: number | null
|
|
11786
|
+
/**
|
|
11787
|
+
* The most candidates kept, a non-negative whole number; 20 when left
|
|
11788
|
+
* out or `null`.
|
|
11789
|
+
*/
|
|
11790
|
+
limit?: number | null
|
|
11791
|
+
}
|
|
11792
|
+
/**
|
|
11793
|
+
* The one form a fuzzy comparison reads: trimmed, lowercased, accents
|
|
11794
|
+
* stripped, every run of whitespace or ASCII punctuation one space.
|
|
11795
|
+
*/
|
|
11796
|
+
export function normalized(text: string): string
|
|
11797
|
+
/** One less the Levenshtein distance over the longer text's characters. */
|
|
11798
|
+
export function similarity(left: string, right: string): number
|
|
11799
|
+
/** `text` with its accents stripped and its case kept. */
|
|
11800
|
+
export function stripAccents(text: string): string
|
|
11801
|
+
}
|
|
11802
|
+
|
|
11803
|
+
export declare namespace mysql {
|
|
11804
|
+
/**
|
|
11805
|
+
* A replay server on `127.0.0.1` serving one captured MySQL or Doris
|
|
11806
|
+
* exchange to every connection, so an example or a test connects with no
|
|
11807
|
+
* database. It stops when collected.
|
|
11808
|
+
*/
|
|
11809
|
+
export class Server {
|
|
11810
|
+
/**
|
|
11811
|
+
* Serve the fixture the addon packages under `name`: `mysql84/` or
|
|
11812
|
+
* `doris413/` and one of `connect`, `listing`, `prepared`, `scan`,
|
|
11813
|
+
* `typed`. A name it does not package is refused by name.
|
|
11814
|
+
*/
|
|
11815
|
+
static bundled(name: string): Server
|
|
11816
|
+
/**
|
|
11817
|
+
* The target a client connects with:
|
|
11818
|
+
* `mysql://root@127.0.0.1:<port>/<database>?ssl-mode=disabled`.
|
|
11819
|
+
*/
|
|
11820
|
+
get url(): string
|
|
11821
|
+
}
|
|
11822
|
+
export type JsMysqlServer = Server
|
|
11823
|
+
}
|