Class Encoder

JSON CRDT Patch "binary" codec encoder.

Hierarchy

CborEncoder<CrdtWriter>
- Encoder

Constructors

constructor

new Encoder(writer?: CrdtWriter): Encoder
Creates a new encoder instance.
Parameters
- writer: CrdtWriter = ...
  An optional custom implementation of CRDT writer.
Returns Encoder
Overrides CborEncoder<CrdtWriter>.constructor
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Encoder.ts:19

Properties

`Readonly`writer

writer: CrdtWriter = ...

An optional custom implementation of CRDT writer.

Methods

encode

encode(patch: Patch): Uint8Array
Encodes a JSON CRDT Patch into a Uint8Array blob.
Parameters
- patch: Patch
  A JSON CRDT Patch to encode.
Returns Uint8Array
A Uint8Array blob containing the encoded JSON CRDT Patch.

Todo
Rename to encodePatch?
Overrides CborEncoder.encode
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Encoder.ts:31

`Protected`encodeId

encodeId(id: ITimestampStruct): void
Parameters
- id: ITimestampStruct
Returns void
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Encoder.ts:57

encodeInteger

encodeInteger(int: number): void
Parameters
- int: number
Returns void
Deprecated
Remove and use writeInteger instead.
Inherited from CborEncoder.encodeInteger
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:25

encodeNint

encodeNint(int: number): void
Parameters
- int: number
Returns void
Inherited from CborEncoder.encodeNint
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:28

encodeNumber

encodeNumber(num: number): void
Parameters
- num: number
Returns void
Deprecated
Remove and use writeNumber instead.
Inherited from CborEncoder.encodeNumber
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:23

`Protected`encodeTss

encodeTss(span: ITimespanStruct): void
Parameters
- span: ITimespanStruct
Returns void
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Encoder.ts:69

encodeUint

encodeUint(uint: number): void
Parameters
- uint: number
Returns void
Deprecated
Inherited from CborEncoder.encodeUint
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:27

writeAny

writeAny(value: unknown): void
Parameters
- value: unknown
Returns void
Inherited from CborEncoder.writeAny
- Defined in packages/json-pack/lib/cbor/CborEncoder.d.ts:10

writeArr

writeArr(arr: unknown[]): void
Parameters
- arr: unknown[]
Returns void
Inherited from CborEncoder.writeArr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:35

writeArrChunk

writeArrChunk(item: unknown): void
Parameters
- item: unknown
Returns void
Inherited from CborEncoder.writeArrChunk
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:57

writeArrHdr

writeArrHdr(length: number): void
Parameters
- length: number
Returns void
Inherited from CborEncoder.writeArrHdr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:36

writeAsciiStr

writeAsciiStr(str: string): void
Parameters
- str: string
Returns void
Inherited from CborEncoder.writeAsciiStr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:34

writeBigInt

writeBigInt(int: bigint): void
Parameters
- int: bigint
Returns void
Inherited from CborEncoder.writeBigInt
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:17

writeBigSint

writeBigSint(int: bigint): void
Parameters
- int: bigint
Returns void
Inherited from CborEncoder.writeBigSint
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:19

writeBigUint

writeBigUint(uint: bigint): void
Parameters
- uint: bigint
Returns void
Inherited from CborEncoder.writeBigUint
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:18

writeBin

writeBin(buf: Uint8Array): void
Parameters
- buf: Uint8Array
Returns void
Inherited from CborEncoder.writeBin
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:30

writeBinChunk

writeBinChunk(buf: Uint8Array): void
Parameters
- buf: Uint8Array
Returns void
Inherited from CborEncoder.writeBinChunk
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:54

writeBinHdr

writeBinHdr(length: number): void
Parameters
- length: number
Returns void
Inherited from CborEncoder.writeBinHdr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:31

writeBoolean

writeBoolean(bool: boolean): void
Parameters
- bool: boolean
Returns void
Inherited from CborEncoder.writeBoolean
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:15

writeCbor

writeCbor(): void
Returns void
Inherited from CborEncoder.writeCbor
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:12

writeEnd

writeEnd(): void
Returns void
Inherited from CborEncoder.writeEnd
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:13

writeEndArr

writeEndArr(): void
Returns void
Inherited from CborEncoder.writeEndArr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:58

writeEndBin

writeEndBin(): void
Returns void
Inherited from CborEncoder.writeEndBin
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:55

writeEndObj

writeEndObj(): void
Returns void
Inherited from CborEncoder.writeEndObj
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:61

writeEndStr

writeEndStr(): void
Returns void
Inherited from CborEncoder.writeEndStr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:52

writeFloat

writeFloat(float: number): void
Parameters
- float: number
Returns void
Inherited from CborEncoder.writeFloat
- Defined in packages/json-pack/lib/cbor/CborEncoder.d.ts:11

writeInteger

writeInteger(int: number): void
Parameters
- int: number
Returns void
Inherited from CborEncoder.writeInteger
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:20

writeMap

writeMap(map: Map<unknown, unknown>): void
Parameters
- map: Map<unknown, unknown>
Returns void
Inherited from CborEncoder.writeMap
- Defined in packages/json-pack/lib/cbor/CborEncoder.d.ts:12

writeMapHdr

writeMapHdr(length: number): void
Parameters
- length: number
Returns void
Inherited from CborEncoder.writeMapHdr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:39

writeNull

writeNull(): void
Returns void
Inherited from CborEncoder.writeNull
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:14

writeNumber

writeNumber(num: number): void
Parameters
- num: number
Returns void
Inherited from CborEncoder.writeNumber
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:16

writeObj

writeObj(obj: Record<string, unknown>): void
Parameters
- obj: Record<string, unknown>
Returns void
Inherited from CborEncoder.writeObj
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:37

writeObjChunk

writeObjChunk(key: string, value: unknown): void
Parameters
- key: string
- value: unknown
Returns void
Inherited from CborEncoder.writeObjChunk
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:60

writeObjHdr

writeObjHdr(length: number): void
Parameters
- length: number
Returns void
Inherited from CborEncoder.writeObjHdr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:38

`Protected`writeOp

writeOp(op: JsonCrdtOperation): void
Parameters
- op: JsonCrdtOperation
Returns void
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Encoder.ts:87

`Protected`writeOps

writeOps(patch: Patch): void
Parameters
- patch: Patch
Returns void
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Encoder.ts:50

writePatch

writePatch(patch: Patch): void
Parameters
- patch: Patch
Returns void
- Defined in packages/json-joy/src/json-crdt-patch/codec/binary/Encoder.ts:38

writeStartArr

writeStartArr(): void
Returns void
Inherited from CborEncoder.writeStartArr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:56

writeStartBin

writeStartBin(): void
Returns void
Inherited from CborEncoder.writeStartBin
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:53

writeStartMap

writeStartMap(): void
Returns void
Inherited from CborEncoder.writeStartMap
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:40

writeStartObj

writeStartObj(): void
Returns void
Inherited from CborEncoder.writeStartObj
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:59

writeStartStr

writeStartStr(): void
Returns void
Inherited from CborEncoder.writeStartStr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:50

writeStr

writeStr(str: string): void
Parameters
- str: string
Returns void
Inherited from CborEncoder.writeStr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:32

writeStrChunk

writeStrChunk(str: string): void
Parameters
- str: string
Returns void
Inherited from CborEncoder.writeStrChunk
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:51

writeStrHdr

writeStrHdr(length: number): void
Parameters
- length: number
Returns void
Inherited from CborEncoder.writeStrHdr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:33

writeTag

writeTag(tag: number, value: unknown): void
Parameters
- tag: number
- value: unknown
Returns void
Inherited from CborEncoder.writeTag
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:41

writeTagHdr

writeTagHdr(tag: number): void
Parameters
- tag: number
Returns void
Inherited from CborEncoder.writeTagHdr
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:42

writeTkn

writeTkn(value: number): void
Writes a CBOR simple value. Values 24 to 31 are not well-formed CBOR and values above 255 are not representable, do not pass them in.
Parameters
- value: number
  Simple value in the range 0 to 255.
Returns void
Inherited from CborEncoder.writeTkn
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:49

writeUInteger

writeUInteger(uint: number): void
Parameters
- uint: number
Returns void
Inherited from CborEncoder.writeUInteger
- Defined in packages/json-pack/lib/cbor/CborEncoderFast.d.ts:21

writeUndef

writeUndef(): void
Returns void
Inherited from CborEncoder.writeUndef
- Defined in packages/json-pack/lib/cbor/CborEncoder.d.ts:13

writeUnknown

writeUnknown(value: unknown): void
Called when the encoder encounters a value that it does not know how to encode.
Parameters
- value: unknown
  Some JavaScript value.
Returns void
Inherited from CborEncoder.writeUnknown
- Defined in packages/json-pack/lib/cbor/CborEncoder.d.ts:9