Class Group

ReadonlygroupID

Readonlymeta

members

• get members(): Endpoint[]

• Returns Endpoint[]

addMember

• addMember(endpoint: Endpoint): void

• Parameters

  • endpoint: Endpoint

  Returns void

command

• command(
      clusterKey: string | number,
      commandKey: string | number,
      payload: KeyValue,
      options?: Options,
  ): Promise<void>

• Parameters

  • clusterKey: string | number
  • commandKey: string | number
  • payload: KeyValue
  • Optionaloptions: Options

  Returns Promise<void>

hasMember

• hasMember(endpoint: Endpoint): boolean

• Parameters

  • endpoint: Endpoint

  Returns boolean

read

• read(
      clusterKey: string | number,
      attributes: (string | number)[],
      options?: Options,
  ): Promise<void>

• Parameters

  • clusterKey: string | number
  • attributes: (string | number)[]
  • Optionaloptions: Options

  Returns Promise<void>

removeFromDatabase

• removeFromDatabase(): void

• Returns void

removeFromNetwork

• removeFromNetwork(): Promise<void>

• Returns Promise<void>

removeMember

• removeMember(endpoint: Endpoint): void

• Parameters

  • endpoint: Endpoint

  Returns void

save

• save(writeDatabase?: boolean): void

• Parameters

  • writeDatabase: boolean = true

  Returns void

write

• write(
      clusterKey: string | number,
      attributes: KeyValue,
      options?: Options,
  ): Promise<void>

• Parameters

  • clusterKey: string | number
  • attributes: KeyValue
  • Optionaloptions: Options

  Returns Promise<void>

Staticall

• all(): Group[]

• Returns Group[]

  Deprecated

  use allIterator()

StaticallIterator

• allIterator(predicate?: (value: Group) => boolean): Generator<Group>

• Parameters

  • Optionalpredicate: (value: Group) => boolean

  Returns Generator<Group>

StaticbyGroupID

• byGroupID(groupID: number): undefined | Group

• Parameters

  • groupID: number

  Returns undefined | Group

Staticcreate

• create(groupID: number): Group

• Parameters

  • groupID: number

  Returns Group

StaticresetCache

• resetCache(): void

• Reset runtime lookups.

  Returns void