Class Decoder

JSON CRDT Patch "binary" codec decoder.

Hierarchy

CborDecoder<CrdtReader>
- Decoder

Constructors

constructor

new Decoder(reader?: CrdtReader): Decoder
Creates a new JSON CRDT patch decoder.
Parameters
- reader: CrdtReader = ...
  An optional custom implementation of a CRDT decoder.
Returns Decoder
Overrides CborDecoder<CrdtReader>.constructor
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Decoder.ts:28

Properties

`Protected`builder

builder: PatchBuilder

`Readonly`keyDecoder

keyDecoder: CachedUtf8Decoder

reader

reader: CrdtReader

Methods

decode

decode(data: Uint8Array): Patch
Decodes a JSON CRDT patch from a binary blob.
Parameters
- data: Uint8Array
  Binary data to decode.
Returns Patch
A JSON CRDT patch.
Overrides CborDecoder.decode
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Decoder.ts:38

`Protected`decodeId

decodeId(): ITimestampStruct
Returns ITimestampStruct
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Decoder.ts:57

decodeLevel

decodeLevel(value: Uint8Array): unknown
Parameters
- value: Uint8Array
Returns unknown
Inherited from CborDecoder.decodeLevel
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:37

f16

f16(): number
Returns number
Inherited from CborDecoder.f16
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:35

find

find(path: Path): this
Parameters
- path: Path
Returns this
Inherited from CborDecoder.find
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:64

findIndex

findIndex(index: number): this
Parameters
- index: number
Returns this
Inherited from CborDecoder.findIndex
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:63

findKey

findKey(key: string): this
Parameters
- key: string
Returns this
Inherited from CborDecoder.findKey
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:62

key

key(): string
Returns string
Inherited from CborDecoder.key
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:31

read

read(uint8: Uint8Array): PackValue
Parameters
- uint8: Uint8Array
Returns PackValue
Inherited from CborDecoder.read
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:10

readAny

readAny(): unknown
Returns unknown
Inherited from CborDecoder.readAny
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:13

readAnyRaw

readAnyRaw(octet: number): unknown
Parameters
- octet: number
Returns unknown
Inherited from CborDecoder.readAnyRaw
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:14

readArr

readArr(minor: number): unknown[]
Parameters
- minor: number
Returns unknown[]
Inherited from CborDecoder.readArr
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:24

readArrHdr

readArrHdr(): number
Returns number
Inherited from CborDecoder.readArrHdr
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:61

readArrIndef

readArrIndef(): unknown[]
Returns unknown[]
Inherited from CborDecoder.readArrIndef
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:26

readArrIndefLevel

readArrIndefLevel(): unknown[]
Returns unknown[]
Inherited from CborDecoder.readArrIndefLevel
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:57

readArrLevel

readArrLevel(minor: number): unknown[]
Parameters
- minor: number
Returns unknown[]
Inherited from CborDecoder.readArrLevel
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:55

readArrRaw

readArrRaw(length: number): unknown[]
Parameters
- length: number
Returns unknown[]
Inherited from CborDecoder.readArrRaw
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:25

readArrRawLevel

readArrRawLevel(length: number): unknown[]
Parameters
- length: number
Returns unknown[]
Inherited from CborDecoder.readArrRawLevel
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:56

readAsMap

readAsMap(): Map<unknown, unknown>
Returns Map<unknown, unknown>
Inherited from CborDecoder.readAsMap
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:6

readAsStr

readAsStr(): string
Returns string
Inherited from CborDecoder.readAsStr
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:20

readAsValue

readAsValue(): JsonPackValue
Returns JsonPackValue
Inherited from CborDecoder.readAsValue
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:51

readBin

readBin(minor: number): Uint8Array
Parameters
- minor: number
Returns Uint8Array
Inherited from CborDecoder.readBin
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:18

readBinChunk

readBinChunk(): Uint8Array
Returns Uint8Array
Inherited from CborDecoder.readBinChunk
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:19

readHdr

readHdr(expectedMajor: number): number
Parameters
- expectedMajor: number
Returns number
Inherited from CborDecoder.readHdr
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:58

readLevel

readLevel(): unknown
Decodes only one level of objects and arrays. Other values are decoded completely.

Returns unknown
One level of decoded CBOR value.
Inherited from CborDecoder.readLevel
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:44

readMap

readMap(minor: number): Map<unknown, unknown>
Parameters
- minor: number
Returns Map<unknown, unknown>
Inherited from CborDecoder.readMap
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:7

readMapIndef

readMapIndef(): Map<unknown, unknown>
Returns Map<unknown, unknown>
Inherited from CborDecoder.readMapIndef
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:9

readMapRaw

readMapRaw(length: number): Map<unknown, unknown>
Parameters
- length: number
Returns Map<unknown, unknown>
Inherited from CborDecoder.readMapRaw
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:8

readMinorLen

readMinorLen(minor: number): number
Parameters
- minor: number
Returns number
Inherited from CborDecoder.readMinorLen
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:15

readNint

readNint(minor: number): number | bigint
Parameters
- minor: number
Returns number | bigint
Inherited from CborDecoder.readNint
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:17

readObj

readObj(minor: number): Record<string, unknown>
Parameters
- minor: number
Returns Record<string, unknown>
Inherited from CborDecoder.readObj
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:27

readObjHdr

readObjHdr(): number
Returns number
Inherited from CborDecoder.readObjHdr
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:60

readObjIndef

readObjIndef(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from CborDecoder.readObjIndef
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:30

readObjIndefLevel

readObjIndefLevel(): Record<string, unknown>
Returns Record<string, unknown>
Inherited from CborDecoder.readObjIndefLevel
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:54

readObjLevel

readObjLevel(minor: number): Record<string, unknown>
Parameters
- minor: number
Returns Record<string, unknown>
Inherited from CborDecoder.readObjLevel
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:52

readObjRaw

readObjRaw(length: number): Record<string, unknown>
Remove this?
Parameters
- length: number
Returns Record<string, unknown>
Inherited from CborDecoder.readObjRaw
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:29

readObjRawLevel

readObjRawLevel(length: number): Record<string, unknown>
Parameters
- length: number
Returns Record<string, unknown>
Inherited from CborDecoder.readObjRawLevel
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:53

readPatch

readPatch(): Patch
Returns Patch
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Decoder.ts:43

readPrimitiveOrVal

readPrimitiveOrVal(): unknown
Decodes primitive values, returns container values as JsonPackValue.

Returns unknown
A primitive value, or CBOR container value as a blob.
Inherited from CborDecoder.readPrimitiveOrVal
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:50

readStr

readStr(minor: number): string
Parameters
- minor: number
Returns string
Inherited from CborDecoder.readStr
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:21

readStrChunk

readStrChunk(): string
Returns string
Inherited from CborDecoder.readStrChunk
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:23

readStrHdr

readStrHdr(): number
Returns number
Inherited from CborDecoder.readStrHdr
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:59

readStrLen

readStrLen(minor: number): number
Parameters
- minor: number
Returns number
Inherited from CborDecoder.readStrLen
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:22

readTag

readTag(minor: number): unknown
Parameters
- minor: number
Returns unknown
Inherited from CborDecoder.readTag
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:32

readTagRaw

readTagRaw(tag: number): unknown
Parameters
- tag: number
Returns unknown
Inherited from CborDecoder.readTagRaw
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:33

readTkn

readTkn(
minor: number,
): undefined | null | number | boolean | JsonPackValue<number>
Parameters
- minor: number
Returns undefined | null | number | boolean | JsonPackValue<number>
Inherited from CborDecoder.readTkn
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:34

readUint

readUint(minor: number): number | bigint
Parameters
- minor: number
Returns number | bigint
Inherited from CborDecoder.readUint
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:16

skipAny

skipAny(): void
Returns void
Inherited from CborDecoder.skipAny
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:11

skipAnyRaw

skipAnyRaw(octet: number): void
Parameters
- octet: number
Returns void
Inherited from CborDecoder.skipAnyRaw
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:12

skipArr

skipArr(minor: number): void
Parameters
- minor: number
Returns void
Inherited from CborDecoder.skipArr
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:19

skipBin

skipBin(minor: number): void
Parameters
- minor: number
Returns void
Inherited from CborDecoder.skipBin
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:15

skipBinChunk

skipBinChunk(): void
Returns void
Inherited from CborDecoder.skipBinChunk
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:16

skipMinorLen

skipMinorLen(minor: number): number
Parameters
- minor: number
Returns number
Inherited from CborDecoder.skipMinorLen
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:13

skipN

skipN(n: number): void
Parameters
- n: number
Returns void
Inherited from CborDecoder.skipN
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:10

skipObj

skipObj(minor: number): void
Parameters
- minor: number
Returns void
Inherited from CborDecoder.skipObj
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:20

skipStr

skipStr(minor: number): void
Parameters
- minor: number
Returns void
Inherited from CborDecoder.skipStr
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:17

skipStrChunk

skipStrChunk(): void
Returns void
Inherited from CborDecoder.skipStrChunk
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:18

skipTag

skipTag(minor: number): void
Parameters
- minor: number
Returns void
Inherited from CborDecoder.skipTag
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:21

skipTkn

skipTkn(minor: number): void
Parameters
- minor: number
Returns void
Inherited from CborDecoder.skipTkn
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:22

skipUNint

skipUNint(minor: number): void
Parameters
- minor: number
Returns void
Inherited from CborDecoder.skipUNint
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:14

val

val(): unknown
Returns unknown
Inherited from CborDecoder.val
- Defined in packages/json-pack/lib/cbor/CborDecoderBase.d.ts:12

validate

validate(value: Uint8Array, offset?: number, size?: number): void
Throws if at given offset in a buffer there is an invalid CBOR value, or if the value does not span the exact length specified in size. I.e. throws if:
- The value is not a valid CBOR value.
- The value is shorter than size.
- The value is longer than size.
Parameters
- value: Uint8Array
  Buffer in which to validate CBOR value.
- Optionaloffset: number
  Offset at which the value starts.
- Optionalsize: number
  Expected size of the value.
Returns void
Inherited from CborDecoder.validate
- Defined in packages/json-pack/lib/cbor/CborDecoder.d.ts:36

Class Decoder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Decoder

Properties

Protectedbuilder

ReadonlykeyDecoder

reader

Methods

decode

Parameters

Returns Patch

ProtecteddecodeId

Returns ITimestampStruct

decodeLevel

Parameters

Returns unknown

ProtecteddecodeOperation

Returns void

ProtecteddecodeOperations

Returns void

ProtecteddecodeTss

Returns ITimespanStruct

f16

Returns number

find

Parameters

Returns this

findIndex

Parameters

Returns this

findKey

Parameters

Returns this

key

Returns string

read

Parameters

Returns PackValue

readAny

Returns unknown

readAnyRaw

Parameters

Returns unknown

readArr

Parameters

Returns unknown[]

readArrHdr

Returns number

readArrIndef

Returns unknown[]

readArrIndefLevel

Returns unknown[]

readArrLevel

Parameters

Returns unknown[]

readArrRaw

Parameters

Returns unknown[]

readArrRawLevel

Parameters

Returns unknown[]

readAsMap

Returns Map<unknown, unknown>

readAsStr

Returns string

readAsValue

Returns JsonPackValue

readBin

Parameters

Returns Uint8Array

readBinChunk

Returns Uint8Array

readHdr

`Protected`builder

`Readonly`keyDecoder

`Protected`decodeId

`Protected`decodeOperation

`Protected`decodeOperations

`Protected`decodeTss