BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/store / Y / UpdateEncoderV1

Class: UpdateEncoderV1 ​

Contents ​

Extends ​

  • DSEncoderV1

Constructors ​

new UpdateEncoderV1(undefined) ​

new UpdateEncoderV1(): UpdateEncoderV1

Returns ​

UpdateEncoderV1

Inherited from ​

DSEncoderV1.constructor

Properties ​

restEncoder ​

restEncoder: Encoder

Inherited from ​

DSEncoderV1.restEncoder

Source ​

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

Methods ​

resetDsCurVal() ​

resetDsCurVal(): void

Returns ​

void

Inherited from ​

DSEncoderV1.resetDsCurVal

Source ​

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

Source ​

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

writeAny() ​

writeAny(any): void

Parameters ​

• any: any

Returns ​

void

Source ​

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

writeBuf() ​

writeBuf(buf): void

Parameters ​

• buf: Uint8Array

Returns ​

void

Source ​

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 ​

• client: number

Returns ​

void

Source ​

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

writeDsClock() ​

writeDsClock(clock): void

Parameters ​

• clock: number

Returns ​

void

Inherited from ​

DSEncoderV1.writeDsClock

Source ​

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

writeDsLen() ​

writeDsLen(len): void

Parameters ​

• len: number

Returns ​

void

Inherited from ​

DSEncoderV1.writeDsLen

Source ​

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

writeInfo() ​

writeInfo(info): void

Parameters ​

• info: number

An unsigned 8-bit integer

Returns ​

void

Source ​

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

writeJSON() ​

writeJSON(embed): void

Parameters ​

• embed: any

Returns ​

void

Source ​

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

writeKey() ​

writeKey(key): void

Parameters ​

• key: string

Returns ​

void

Source ​

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

writeLeftID() ​

writeLeftID(id): void

Parameters ​

• id: ID

Returns ​

void

Source ​

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 ​

• len: number

Returns ​

void

Source ​

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

writeParentInfo() ​

writeParentInfo(isYKey): void

Parameters ​

• isYKey: boolean

Returns ​

void

Source ​

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

writeRightID() ​

writeRightID(id): void

Parameters ​

• id: ID

Returns ​

void

Source ​

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

writeString() ​

writeString(s): void

Parameters ​

• s: string

Returns ​

void

Source ​

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

writeTypeRef() ​

writeTypeRef(info): void

Parameters ​

• info: number

An unsigned 8-bit integer

Returns ​

void

Source ​

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

Generated using typedoc-plugin-markdown and TypeDoc

Copyright © 2022-present Toeverything