Skip to content

API > @blocksuite/store > Y > UpdateEncoderV1

Class: UpdateEncoderV1 ​

Extends ​

  • DSEncoderV1

Constructors ​

constructor ​

new UpdateEncoderV1(): UpdateEncoderV1

Returns ​

UpdateEncoderV1

Inherited from ​

DSEncoderV1.constructor

Properties ​

restEncoder ​

restEncoder: Encoder

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:2

Inherited from ​

DSEncoderV1.restEncoder

Methods ​

resetDsCurVal ​

resetDsCurVal(): void

Returns ​

void

Inherited from ​

DSEncoderV1.resetDsCurVal

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:4


toUint8Array ​

toUint8Array(): Uint8Array

Returns ​

Uint8Array

Inherited from ​

DSEncoderV1.toUint8Array

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:3


writeAny ​

writeAny(any): void

Parameters ​

ParameterType
anyany

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:53


writeBuf ​

writeBuf(buf): void

Parameters ​

ParameterType
bufUint8Array

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:57


writeClient ​

writeClient(client): void

Use writeClient and writeClock instead of writeID if possible.

Parameters ​

ParameterType
clientnumber

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:27


writeDsClock ​

writeDsClock(clock): void

Parameters ​

ParameterType
clocknumber

Returns ​

void

Inherited from ​

DSEncoderV1.writeDsClock

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:8


writeDsLen ​

writeDsLen(len): void

Parameters ​

ParameterType
lennumber

Returns ​

void

Inherited from ​

DSEncoderV1.writeDsLen

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:12


writeInfo ​

writeInfo(info): void

Parameters ​

ParameterTypeDescription
infonumberAn unsigned 8-bit integer

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:31


writeJSON ​

writeJSON(embed): void

Parameters ​

ParameterType
embedany

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:61


writeKey ​

writeKey(key): void

Parameters ​

ParameterType
keystring

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:65


writeLeftID ​

writeLeftID(id): void

Parameters ​

ParameterType
idID

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:18


writeLen ​

writeLen(len): void

Write len of a struct - well suited for Opt RLE encoder.

Parameters ​

ParameterType
lennumber

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:49


writeParentInfo ​

writeParentInfo(isYKey): void

Parameters ​

ParameterType
isYKeyboolean

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:39


writeRightID ​

writeRightID(id): void

Parameters ​

ParameterType
idID

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:22


writeString ​

writeString(s): void

Parameters ​

ParameterType
sstring

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:35


writeTypeRef ​

writeTypeRef(info): void

Parameters ​

ParameterTypeDescription
infonumberAn unsigned 8-bit integer

Returns ​

void

Defined In ​

node_modules/.pnpm/yjs@13.6.10/node_modules/yjs/dist/src/utils/UpdateEncoder.d.ts:43