Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MetadataCursor

An implementation of a metadata cursor.

Hierarchy

  • MetadataCursor

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new MetadataCursor(name: string, read: function, write: function): MetadataCursor

  • Construct a new metadata cursor.

    Parameters

    • name: string

      The metadata namespace key.

    • read: function

      The read callback.

        • (): any

        • Returns any

    • write: function

      The write callback.

        • (value: any): void

        • Parameters

          • value: any

          Returns void

    Returns MetadataCursor

Properties

Private _name

_name: string

Private _read

_read: function

Type declaration

    • (): string

    • Returns string

Private _write

_write: function

Type declaration

    • (value: string): void

    • Parameters

      • value: string

      Returns void

Accessors

name

  • get (): string

  • Get the namespace key of the metadata.

    Notes

    This is a read-only property.

    Returns string

Methods

dispose

  • dispose(): void

  • Dispose of the resources used by the cursor.

    Notes

    This is not meant to be called by user code.

    Returns void

getValue

  • getValue(): any

setValue

  • setValue(value: any): void

Generated using TypeDoc