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

Class: GC

Extends

• AbstractStruct

Constructors

new GC(id, length)

new GC(id, length): GC

Parameters

• id: ID

• length: number

Returns

GC

Inherited from

AbstractStruct.constructor

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/AbstractStruct.d.ts:6

Properties

id

id: ID

Inherited from

AbstractStruct.id

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/AbstractStruct.d.ts:7

---

length

length: number

Inherited from

AbstractStruct.length

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/AbstractStruct.d.ts:8

Accessors

deleted

get deleted(): boolean

Returns

boolean

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/AbstractStruct.d.ts:12

Methods

delete()

delete(): void

Returns

void

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/GC.d.ts:6

---

getMissing()

getMissing(transaction, store): null | number

Parameters

• transaction: Transaction

• store: StructStore

Returns

null | number

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/GC.d.ts:22

---

integrate()

integrate(transaction, offset): void

Parameters

• transaction: Transaction

• offset: number

Returns

void

Inherited from

AbstractStruct.integrate

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/AbstractStruct.d.ts:31

---

mergeWith()

mergeWith(right): boolean

Parameters

• right: GC

Returns

boolean

Overrides

AbstractStruct.mergeWith

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/GC.d.ts:11

---

write()

write(encoder, offset): void

Parameters

• encoder: UpdateEncoderV1 | UpdateEncoderV2

• offset: number

Returns

void

Overrides

AbstractStruct.write

Source

node_modules/.pnpm/yjs@13.6.14/node_modules/yjs/dist/src/structs/GC.d.ts:16