Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Properties

Properties

default

default: { IDLDecode: (bytes: Buffer) => JsonValue[]; IDLEncode: (argTypes: Type<any>[], args: any[]) => BinaryBlob; PlugKeyRing: typeof default; getAccountId: (principal: Principal, subaccount?: number, cryptoAdapter?: typeof CryptoJS) => string; getCanisterInfo: (canisterId: string, agent?: HttpAgent, fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) => Promise<undefined | CanisterInfo>; getMultipleCanisterInfo: (canisterIds: string[], agent?: HttpAgent, fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) => Promise<CanisterInfo[]> }

Type declaration

  • IDLDecode: (bytes: Buffer) => JsonValue[]
      • (bytes: Buffer): JsonValue[]
      • Decode a binary value

        Parameters

        • bytes: Buffer

          hex-encoded string, or buffer.

        Returns JsonValue[]

        Value deserialised to JS type

  • IDLEncode: (argTypes: Type<any>[], args: any[]) => BinaryBlob
      • (argTypes: Type<any>[], args: any[]): BinaryBlob
      • Encode a array of values

        Parameters

        • argTypes: Type<any>[]
        • args: any[]

        Returns BinaryBlob

        serialised value

  • PlugKeyRing: typeof default
  • getAccountId: (principal: Principal, subaccount?: number, cryptoAdapter?: typeof CryptoJS) => string
      • (principal: Principal, subaccount?: number, cryptoAdapter?: typeof CryptoJS): string
      • Parameters

        • principal: Principal
        • Optional subaccount: number
        • cryptoAdapter: typeof CryptoJS = ...

        Returns string

  • getCanisterInfo: (canisterId: string, agent?: HttpAgent, fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) => Promise<undefined | CanisterInfo>
      • (canisterId: string, agent?: HttpAgent, fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>): Promise<undefined | CanisterInfo>
      • Parameters

        • canisterId: string
        • Optional agent: HttpAgent
        • Optional fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>
            • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
            • Parameters

              • input: RequestInfo | URL
              • Optional init: RequestInit

              Returns Promise<Response>

        Returns Promise<undefined | CanisterInfo>

  • getMultipleCanisterInfo: (canisterIds: string[], agent?: HttpAgent, fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>) => Promise<CanisterInfo[]>
      • (canisterIds: string[], agent?: HttpAgent, fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>): Promise<CanisterInfo[]>
      • Parameters

        • canisterIds: string[]
        • Optional agent: HttpAgent
        • Optional fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>
            • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>
            • Parameters

              • input: RequestInfo | URL
              • Optional init: RequestInit

              Returns Promise<Response>

        Returns Promise<CanisterInfo[]>

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Class
  • Class with type parameter
  • Enumeration