decodeAll
Call Signature
Section titled “Call Signature”decodeAll<
T,W>(decoder,input,options?):DecodeAllResult<T,Uint8Array<ArrayBufferLike>,W>
Defined in: packages/format-core/src/decode-all.ts:59
Decode every value a repeatable-item format contains in one complete input — a CBOR sequence (RFC 8742), concatenated netstrings, the rows of a CSV document, or any other back-to-back sequence of values.
This is the synchronous face of a Decoder: a package’s parse*
utility is built on this rather than reimplementing the grammar. Built on
DecodeDriver, so a recoverable error is collected and decoding
continues instead of aborting on the first bad item.
Type Parameters
Section titled “Type Parameters”T
W = never
Parameters
Section titled “Parameters”decoder
Section titled “decoder”Decoder<T, Uint8Array<ArrayBufferLike>, W>
Uint8Array
options?
Section titled “options?”DecodeAllOptions<Uint8Array<ArrayBufferLike>, Uint8Array<ArrayBufferLike>>
Returns
Section titled “Returns”DecodeAllResult<T, Uint8Array<ArrayBufferLike>, W>
Call Signature
Section titled “Call Signature”decodeAll<
T,View,Chunk,W>(decoder,input,options):DecodeAllResult<T,Chunk,W>
Defined in: packages/format-core/src/decode-all.ts:64
Decode every value a repeatable-item format contains in one complete input — a CBOR sequence (RFC 8742), concatenated netstrings, the rows of a CSV document, or any other back-to-back sequence of values.
This is the synchronous face of a Decoder: a package’s parse*
utility is built on this rather than reimplementing the grammar. Built on
DecodeDriver, so a recoverable error is collected and decoding
continues instead of aborting on the first bad item.
Type Parameters
Section titled “Type Parameters”T
View
Chunk
W = never
Parameters
Section titled “Parameters”decoder
Section titled “decoder”Decoder<T, View, W>
Chunk
options
Section titled “options”Required<DecodeAllOptions<View, Chunk>>
Returns
Section titled “Returns”DecodeAllResult<T, Chunk, W>