Class KeyStates

constructor

• new KeyStates(client: SignifyClient): KeyStates

  KeyStates

  Parameters

  • client: SignifyClient

  Returns KeyStates

client

get

• get(
      pre: string,
  ): Promise<
      {
          b: string[];
          bt: string;
          c: string[];
          d: string;
          di: string;
          dt: string;
          ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
          et: string;
          f: string;
          i: string;
          k: string[];
          kt: string | string[];
          n: string[];
          nt: string | string[];
          p: string;
          s: string;
          vn?: number[];
      }[],
  >

  Retriene the key state for an identifier

  Parameters

  • pre: string

    Identifier prefix

  Returns Promise<
      {
          b: string[];
          bt: string;
          c: string[];
          d: string;
          di: string;
          dt: string;
          ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
          et: string;
          f: string;
          i: string;
          k: string[];
          kt: string | string[];
          n: string[];
          nt: string | string[];
          p: string;
          s: string;
          vn?: number[];
      }[],
  >

  A promise to the key states

  Async

list

• list(
      pres: string[],
  ): Promise<
      {
          b: string[];
          bt: string;
          c: string[];
          d: string;
          di: string;
          dt: string;
          ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
          et: string;
          f: string;
          i: string;
          k: string[];
          kt: string | string[];
          n: string[];
          nt: string | string[];
          p: string;
          s: string;
          vn?: number[];
      }[],
  >

  Retrieve the key state for a list of identifiers

  Parameters

  • pres: string[]

    List of identifier prefixes

  Returns Promise<
      {
          b: string[];
          bt: string;
          c: string[];
          d: string;
          di: string;
          dt: string;
          ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
          et: string;
          f: string;
          i: string;
          k: string[];
          kt: string | string[];
          n: string[];
          nt: string | string[];
          p: string;
          s: string;
          vn?: number[];
      }[],
  >

  A promise to the key states

  Async

query

• query(
      pre: string,
      sn?: string,
      anchor?: any,
  ): Promise<
      | {
          done: false;
          metadata?: {
              anchor?: { d: string; pre: string; sn: number };
              pre: string;
              sn: number;
          };
          name: string;
      }
      | {
          done: true;
          metadata?: {
              anchor?: { d: string; pre: string; sn: number };
              pre: string;
              sn: number;
          };
          name: string;
          response: {
              b: string[];
              bt: string;
              c: string[];
              d: string;
              di: string;
              dt: string;
              ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
              et: string;
              f: string;
              i: string;
              k: string[];
              kt: string | string[];
              n: string[];
              nt: string | string[];
              p: string;
              s: string;
              vn?: number[];
          };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: {
              anchor?: { d: string; pre: string; sn: number };
              pre: string;
              sn: number;
          };
          name: string;
      },
  >

  Query the key state of an identifier for a given sequence number or anchor

  Parameters

  • pre: string

    Identifier prefix

  • Optionalsn: string

    Optional sequence number

  • Optionalanchor: any

    Optional anchor

  Returns Promise<
      | {
          done: false;
          metadata?: {
              anchor?: { d: string; pre: string; sn: number };
              pre: string;
              sn: number;
          };
          name: string;
      }
      | {
          done: true;
          metadata?: {
              anchor?: { d: string; pre: string; sn: number };
              pre: string;
              sn: number;
          };
          name: string;
          response: {
              b: string[];
              bt: string;
              c: string[];
              d: string;
              di: string;
              dt: string;
              ee: { ba?: unknown[]; br?: unknown[]; d: string; s: string };
              et: string;
              f: string;
              i: string;
              k: string[];
              kt: string | string[];
              n: string[];
              nt: string | string[];
              p: string;
              s: string;
              vn?: number[];
          };
      }
      | {
          done: true;
          error: {
              code: number;
              details?: null
              | { [key: string]: unknown };
              message: string;
          };
          metadata?: {
              anchor?: { d: string; pre: string; sn: number };
              pre: string;
              sn: number;
          };
          name: string;
      },
  >

  A promise to the long-running operation

  Async