Type alias NameAdmin

NameAdmin: {
    default: (<T>(key, newValue, newAdmin?) => T);
    delete: ((key) => void);
    lookupAdmin: ((...path) => Promise<NameAdmin>);
    onUpdate: ((fn) => void);
    provideChild: ((key, reserved?) => Promise<NameHubKit>);
    readonly: (() => NameHub);
    reserve: ((key) => Promise<void>);
    set: ((key, newValue, newAdmin?) => void);
    update: ((key, newValue, newAdmin?) => void);
}

write access to a node in a name hierarchy

Type declaration

  • default: (<T>(key, newValue, newAdmin?) => T)

    Update if not already updated. Return existing value, or newValue if not existing.

      • <T>(key, newValue, newAdmin?): T

      • Type Parameters

        • T

        Parameters

        • key: string
        • newValue: T
        • Optional newAdmin: NameAdmin

        Returns T

  • delete: ((key) => void)

    Delete a value and reject an outstanding reserved promise (if any).

      • (key): void

      • Parameters

        • key: string

        Returns void

  • lookupAdmin: ((...path) => Promise<NameAdmin>)

    Look up the newAdmin from the path of keys starting from the current NameAdmin. Wait on any reserved promises.

  • onUpdate: ((fn) => void)
  • provideChild: ((key, reserved?) => Promise<NameHubKit>)
      • (key, reserved?): Promise<NameHubKit>

      • Parameters

        • key: string
        • Optional reserved: string[]

        Returns Promise<NameHubKit>

  • readonly: (() => NameHub)

    get the NameHub corresponding to the current NameAdmin

  • reserve: ((key) => Promise<void>)

    Mark a key as reserved; will return a promise that is fulfilled when the key is updated (or rejected when deleted). If the key was already set it does nothing.

      • (key): Promise<void>

      • Parameters

        • key: string

        Returns Promise<void>

  • set: ((key, newValue, newAdmin?) => void)

    Update only if already initialized. Reject if not.

      • (key, newValue, newAdmin?): void

      • Parameters

        • key: string
        • newValue: any
        • Optional newAdmin: NameAdmin

        Returns void

  • update: ((key, newValue, newAdmin?) => void)

    Fulfill an outstanding reserved promise (if any) to the newValue and set the key to the newValue. If newAdmin is provided, set that to return via lookupAdmin.

      • (key, newValue, newAdmin?): void

      • Parameters

        • key: string
        • newValue: any
        • Optional newAdmin: NameAdmin

        Returns void

Settings

Member Visibility

Theme