Skip to content

Commit 8c6fc35

Browse files
solidsnakedevsolidsnakedev
committed
docs: update docs
1 parent 6081f27 commit 8c6fc35

File tree

14 files changed

+332
-122
lines changed

14 files changed

+332
-122
lines changed

‎docs/content/docs/modules/core/CBOR.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,7 @@ export declare const isRecord: (
536536
export declare const isTag: (
537537
u: unknown,
538538
overrideOptions?: ParseOptions | number
539-
) => u is { readonly _tag: "Tag"; readonly value: CBOR; readonly tag: number }
539+
) => u is { readonly _tag: "Tag"; readonly tag: number; readonly value: CBOR }
540540
```
541541
542542
## map

‎docs/content/docs/modules/core/ProposalProcedure.mdx‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -191,10 +191,10 @@ export declare const CDDLSchema: Schema.Tuple<
191191
readonly [any, bigint] | null,
192192
(
193193
| readonly (readonly [0n | 1n, any])[]
194-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
194+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
195195
),
196196
ReadonlyMap<readonly [0n | 1n, any], bigint>,
197-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
197+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
198198
]
199199
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
200200
| readonly [6n],
@@ -207,10 +207,10 @@ export declare const CDDLSchema: Schema.Tuple<
207207
readonly [any, bigint] | null,
208208
(
209209
| readonly (readonly [0n | 1n, any])[]
210-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
210+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
211211
),
212212
ReadonlyMap<readonly [0n | 1n, any], bigint>,
213-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
213+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
214214
]
215215
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
216216
| readonly [6n],
@@ -253,10 +253,10 @@ export declare const FromCBORBytes: (
253253
readonly [any, bigint] | null,
254254
(
255255
| readonly (readonly [0n | 1n, any])[]
256-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
256+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
257257
),
258258
ReadonlyMap<readonly [0n | 1n, any], bigint>,
259-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
259+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
260260
]
261261
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
262262
| readonly [6n],
@@ -269,10 +269,10 @@ export declare const FromCBORBytes: (
269269
readonly [any, bigint] | null,
270270
(
271271
| readonly (readonly [0n | 1n, any])[]
272-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
272+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
273273
),
274274
ReadonlyMap<readonly [0n | 1n, any], bigint>,
275-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
275+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
276276
]
277277
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
278278
| readonly [6n],
@@ -321,10 +321,10 @@ export declare const FromCBORHex: (
321321
readonly [any, bigint] | null,
322322
(
323323
| readonly (readonly [0n | 1n, any])[]
324-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
324+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
325325
),
326326
ReadonlyMap<readonly [0n | 1n, any], bigint>,
327-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
327+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
328328
]
329329
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
330330
| readonly [6n],
@@ -337,10 +337,10 @@ export declare const FromCBORHex: (
337337
readonly [any, bigint] | null,
338338
(
339339
| readonly (readonly [0n | 1n, any])[]
340-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
340+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
341341
),
342342
ReadonlyMap<readonly [0n | 1n, any], bigint>,
343-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
343+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
344344
]
345345
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
346346
| readonly [6n],
@@ -380,10 +380,10 @@ export declare const FromCDDL: Schema.transformOrFail<
380380
readonly [any, bigint] | null,
381381
(
382382
| readonly (readonly [0n | 1n, any])[]
383-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
383+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
384384
),
385385
ReadonlyMap<readonly [0n | 1n, any], bigint>,
386-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
386+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
387387
]
388388
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
389389
| readonly [6n],
@@ -396,10 +396,10 @@ export declare const FromCDDL: Schema.transformOrFail<
396396
readonly [any, bigint] | null,
397397
(
398398
| readonly (readonly [0n | 1n, any])[]
399-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
399+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
400400
),
401401
ReadonlyMap<readonly [0n | 1n, any], bigint>,
402-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
402+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
403403
]
404404
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
405405
| readonly [6n],

‎docs/content/docs/modules/core/ProposalProcedures.mdx‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -181,10 +181,10 @@ export declare const CDDLSchema: Schema.Array$<
181181
readonly [any, bigint] | null,
182182
(
183183
| readonly (readonly [0n | 1n, any])[]
184-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
184+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
185185
),
186186
ReadonlyMap<readonly [0n | 1n, any], bigint>,
187-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
187+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
188188
]
189189
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
190190
| readonly [6n],
@@ -197,10 +197,10 @@ export declare const CDDLSchema: Schema.Array$<
197197
readonly [any, bigint] | null,
198198
(
199199
| readonly (readonly [0n | 1n, any])[]
200-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
200+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
201201
),
202202
ReadonlyMap<readonly [0n | 1n, any], bigint>,
203-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
203+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
204204
]
205205
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
206206
| readonly [6n],
@@ -245,10 +245,10 @@ export declare const FromCBORBytes: (
245245
readonly [any, bigint] | null,
246246
(
247247
| readonly (readonly [0n | 1n, any])[]
248-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
248+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
249249
),
250250
ReadonlyMap<readonly [0n | 1n, any], bigint>,
251-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
251+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
252252
]
253253
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
254254
| readonly [6n],
@@ -261,10 +261,10 @@ export declare const FromCBORBytes: (
261261
readonly [any, bigint] | null,
262262
(
263263
| readonly (readonly [0n | 1n, any])[]
264-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
264+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
265265
),
266266
ReadonlyMap<readonly [0n | 1n, any], bigint>,
267-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
267+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
268268
]
269269
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
270270
| readonly [6n],
@@ -315,10 +315,10 @@ export declare const FromCBORHex: (
315315
readonly [any, bigint] | null,
316316
(
317317
| readonly (readonly [0n | 1n, any])[]
318-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
318+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
319319
),
320320
ReadonlyMap<readonly [0n | 1n, any], bigint>,
321-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
321+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
322322
]
323323
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
324324
| readonly [6n],
@@ -331,10 +331,10 @@ export declare const FromCBORHex: (
331331
readonly [any, bigint] | null,
332332
(
333333
| readonly (readonly [0n | 1n, any])[]
334-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
334+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
335335
),
336336
ReadonlyMap<readonly [0n | 1n, any], bigint>,
337-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
337+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
338338
]
339339
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
340340
| readonly [6n],
@@ -376,10 +376,10 @@ export declare const FromCDDL: Schema.transformOrFail<
376376
readonly [any, bigint] | null,
377377
(
378378
| readonly (readonly [0n | 1n, any])[]
379-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
379+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
380380
),
381381
ReadonlyMap<readonly [0n | 1n, any], bigint>,
382-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
382+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
383383
]
384384
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
385385
| readonly [6n],
@@ -392,10 +392,10 @@ export declare const FromCDDL: Schema.transformOrFail<
392392
readonly [any, bigint] | null,
393393
(
394394
| readonly (readonly [0n | 1n, any])[]
395-
| { readonly _tag: "Tag"; readonly value: readonly (readonly [0n | 1n, any])[]; readonly tag: 258 }
395+
| { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
396396
),
397397
ReadonlyMap<readonly [0n | 1n, any], bigint>,
398-
{ readonly _tag: "Tag"; readonly value: readonly [bigint, bigint]; readonly tag: 30 }
398+
{ readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
399399
]
400400
| readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
401401
| readonly [6n],

0 commit comments

Comments
 (0)