Class AccessList

constructor

• new AccessList(name: AccessListName): AccessList

  Parameters

  • name: AccessListName

  Returns AccessList

Readonlyname

add

• add(ids: string | readonly string[]): this

  Add one id or many. Duplicates are ignored. Throws TypeError on an empty/non-string id.

  Parameters

  • ids: string | readonly string[]

  Returns this

remove

• remove(ids: string | readonly string[]): this

  Remove one id or many. Unknown ids are ignored. Throws TypeError on an empty/non-string id.

  Parameters

  • ids: string | readonly string[]

  Returns this

has

• has(id: string): boolean

  Is id on the list? Exact, case-sensitive match. Never throws.

  Parameters

  • id: string

  Returns boolean

list

• list(): string[]

  The ids on the list, in insertion order (a copy).

  Returns string[]

clear

• clear(): this

  Remove every id.

  Returns this

load

• load(snapshot: readonly string[] | AccessListSnapshot): this

  Replace the contents with a snapshot from export (or a bare id array). Always notifies onChange listeners with action 'load'.

  Parameters

  • snapshot: readonly string[] | AccessListSnapshot

  Returns this

export

• export(): AccessListSnapshot

  JSON-serializable snapshot for host-side persistence.

  Returns AccessListSnapshot

onChange

• onChange(listener: (change: AccessListChange) => void): () => void

  Subscribe to effective mutations (no-op calls do not notify). Returns an unsubscriber. A throwing listener never breaks the mutation that triggered it.

  Parameters

  • listener: (change: AccessListChange) => void

  Returns () => void

size

• get size(): number

  Number of ids on the list.

  Returns number