Query <TInstructions, TDescriptor>

Index

Constructors

• constructor

Properties

• callApi
• callApis
• getConstant
• readStorage
• readStorageEntries
• readStorages

Accessors

• instructions

Methods

• concat
• constant
• runtimeApi
• runtimeApis
• storage
• storageEntries
• storages

Constructors

constructor

• new Query<TInstructions, TDescriptor>(instructions?: TInstructions): Query<TInstructions, TDescriptor>

• Type parameters

  • TInstructions: QueryInstruction<ChainDefinition>[] = QueryInstruction<ChainDefinition>[]
  • TDescriptor: ChainDefinition = ChainDefinition

  Parameters

  • instructions: TInstructions = ...

  Returns Query<TInstructions, TDescriptor>

Properties

callApi

callApi: <TPallet, TApi, TArguments>(pallet: TPallet, api: TApi, ...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]) => Query<[...TInstructions[], { api: TApi; args: any[] | TArguments; at: At; instruction: call-api; pallet: TPallet }], TDescriptor> = ...

@deprecated

Use Query.runtimeApi instead.

---

Type declaration

• • <TPallet, TApi, TArguments>(pallet: TPallet, api: TApi, ...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]): Query<[...TInstructions[], { api: TApi; args: any[] | TArguments; at: At; instruction: call-api; pallet: TPallet }], TDescriptor>

  • Type parameters

    • TPallet: string | number | symbol
    • TApi: string | number | symbol
    • TArguments

    Parameters

    • pallet: TPallet

    • api: TApi

    • rest...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]

    Returns Query<[...TInstructions[], { api: TApi; args: any[] | TArguments; at: At; instruction: call-api; pallet: TPallet }], TDescriptor>

callApis

callApis: <TPallet, TApi, TArguments>(pallet: TPallet, api: TApi, args: TArguments[], options?: { at?: At }) => Query<[...TInstructions[], { api: TApi; args: TArguments[]; at: At; instruction: call-api; multi: true; pallet: TPallet }], TDescriptor> = ...

@deprecated

Use Query.runtimeApis instead.

---

Type declaration

• • <TPallet, TApi, TArguments>(pallet: TPallet, api: TApi, args: TArguments[], options?: { at?: At }): Query<[...TInstructions[], { api: TApi; args: TArguments[]; at: At; instruction: call-api; multi: true; pallet: TPallet }], TDescriptor>

  • Type parameters

    • TPallet: string | number | symbol
    • TApi: string | number | symbol
    • TArguments

    Parameters

    • pallet: TPallet

    • api: TApi

    • args: TArguments[]

    • optionaloptions: { at?: At }

    • optionalat: At

    Returns Query<[...TInstructions[], { api: TApi; args: TArguments[]; at: At; instruction: call-api; multi: true; pallet: TPallet }], TDescriptor>

getConstant

getConstant: <TPallet, TConstant>(pallet: TPallet, constant: TConstant) => Query<[...TInstructions[], { constant: TConstant; instruction: get-constant; pallet: TPallet }], TDescriptor> = ...

@deprecated

Use Query.constant instead.

---

Type declaration

• • <TPallet, TConstant>(pallet: TPallet, constant: TConstant): Query<[...TInstructions[], { constant: TConstant; instruction: get-constant; pallet: TPallet }], TDescriptor>

  • Type parameters

    • TPallet: string | number | symbol
    • TConstant: string | number | symbol

    Parameters

    • pallet: TPallet

    • constant: TConstant

    Returns Query<[...TInstructions[], { constant: TConstant; instruction: get-constant; pallet: TPallet }], TDescriptor>

readStorage

readStorage: <TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, ...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]) => Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage; pallet: TPallet; storage: TStorage }], TDescriptor> = ...

@deprecated

Use Query.storage instead.

---

Type declaration

• • <TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, ...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]): Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage; pallet: TPallet; storage: TStorage }], TDescriptor>

  • Type parameters

    • TPallet: string | number | symbol
    • TStorage: string | number | symbol
    • TArguments

    Parameters

    • pallet: TPallet

    • storage: TStorage

    • rest...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]

    Returns Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage; pallet: TPallet; storage: TStorage }], TDescriptor>

readStorageEntries

readStorageEntries: <TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, args?: TArguments, options?: { at?: At }) => Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage-entries; pallet: TPallet; storage: TStorage }], TDescriptor> = ...

@deprecated

Use Query.storageEntries instead.

---

Type declaration

• • <TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, args?: TArguments, options?: { at?: At }): Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage-entries; pallet: TPallet; storage: TStorage }], TDescriptor>

  • Type parameters

    • TPallet: string | number | symbol
    • TStorage: string | number | symbol
    • TArguments

    Parameters

    • pallet: TPallet

    • storage: TStorage

    • optionalargs: TArguments

    • optionaloptions: { at?: At }

    • optionalat: At

    Returns Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage-entries; pallet: TPallet; storage: TStorage }], TDescriptor>

readStorages

readStorages: <TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, args: TArguments[], options?: { at?: At }) => Query<[...TInstructions[], { args: TArguments[]; at: At; instruction: read-storage; multi: true; pallet: TPallet; storage: TStorage }], TDescriptor> = ...

@deprecated

Use Query.storages instead.

---

Type declaration

• • <TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, args: TArguments[], options?: { at?: At }): Query<[...TInstructions[], { args: TArguments[]; at: At; instruction: read-storage; multi: true; pallet: TPallet; storage: TStorage }], TDescriptor>

  • Type parameters

    • TPallet: string | number | symbol
    • TStorage: string | number | symbol
    • TArguments

    Parameters

    • pallet: TPallet

    • storage: TStorage

    • args: TArguments[]

    • optionaloptions: { at?: At }

    • optionalat: At

    Returns Query<[...TInstructions[], { args: TArguments[]; at: At; instruction: read-storage; multi: true; pallet: TPallet; storage: TStorage }], TDescriptor>

Accessors

instructions

• get instructions(): Readonly<TInstructions>

• Returns Readonly<TInstructions>

Methods

concat

• concat<TQueries>(...queries: TQueries): Query<[...TInstructions[], ...Flatten<{ [ P in string | number | symbol ]: TQueries[P<P>] extends Query<Instructions, _> ? Instructions : never }>[]], TDescriptor>

• Type parameters

  • TQueries: Query<QueryInstruction<ChainDefinition>[], ChainDefinition>[]

  Parameters

  • rest...queries: TQueries

  Returns Query<[...TInstructions[], ...Flatten<{ [ P in string | number | symbol ]: TQueries[P<P>] extends Query<Instructions, _> ? Instructions : never }>[]], TDescriptor>

constant

• constant<TPallet, TConstant>(pallet: TPallet, constant: TConstant): Query<[...TInstructions[], { constant: TConstant; instruction: get-constant; pallet: TPallet }], TDescriptor>

• Type parameters

  • TPallet: string | number | symbol
  • TConstant: string | number | symbol

  Parameters

  • pallet: TPallet

  • constant: TConstant

  Returns Query<[...TInstructions[], { constant: TConstant; instruction: get-constant; pallet: TPallet }], TDescriptor>

runtimeApi

• runtimeApi<TPallet, TApi, TArguments>(pallet: TPallet, api: TApi, ...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]): Query<[...TInstructions[], { api: TApi; args: any[] | TArguments; at: At; instruction: call-api; pallet: TPallet }], TDescriptor>

• Type parameters

  • TPallet: string | number | symbol
  • TApi: string | number | symbol
  • TArguments

  Parameters

  • pallet: TPallet

  • api: TApi

  • rest...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]

  Returns Query<[...TInstructions[], { api: TApi; args: any[] | TArguments; at: At; instruction: call-api; pallet: TPallet }], TDescriptor>

runtimeApis

• runtimeApis<TPallet, TApi, TArguments>(pallet: TPallet, api: TApi, args: TArguments[], options?: { at?: At }): Query<[...TInstructions[], { api: TApi; args: TArguments[]; at: At; instruction: call-api; multi: true; pallet: TPallet }], TDescriptor>

• Type parameters

  • TPallet: string | number | symbol
  • TApi: string | number | symbol
  • TArguments

  Parameters

  • pallet: TPallet

  • api: TApi

  • args: TArguments[]

  • optionaloptions: { at?: At }

  • optionalat: At

  Returns Query<[...TInstructions[], { api: TApi; args: TArguments[]; at: At; instruction: call-api; multi: true; pallet: TPallet }], TDescriptor>

storage

• storage<TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, ...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]): Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage; pallet: TPallet; storage: TStorage }], TDescriptor>

• Type parameters

  • TPallet: string | number | symbol
  • TStorage: string | number | symbol
  • TArguments

  Parameters

  • pallet: TPallet

  • storage: TStorage

  • rest...argsAndOptions: TArguments extends [] ? [args?: TArguments<TArguments>, options?: { at?: At }] : [args: TArguments, options?: { at?: At }]

  Returns Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage; pallet: TPallet; storage: TStorage }], TDescriptor>

storageEntries

• storageEntries<TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, args?: TArguments, options?: { at?: At }): Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage-entries; pallet: TPallet; storage: TStorage }], TDescriptor>

• Type parameters

  • TPallet: string | number | symbol
  • TStorage: string | number | symbol
  • TArguments

  Parameters

  • pallet: TPallet

  • storage: TStorage

  • optionalargs: TArguments

  • optionaloptions: { at?: At }

  • optionalat: At

  Returns Query<[...TInstructions[], { args: any[] | TArguments; at: At; instruction: read-storage-entries; pallet: TPallet; storage: TStorage }], TDescriptor>

storages

• storages<TPallet, TStorage, TArguments>(pallet: TPallet, storage: TStorage, args: TArguments[], options?: { at?: At }): Query<[...TInstructions[], { args: TArguments[]; at: At; instruction: read-storage; multi: true; pallet: TPallet; storage: TStorage }], TDescriptor>

• Type parameters

  • TPallet: string | number | symbol
  • TStorage: string | number | symbol
  • TArguments

  Parameters

  • pallet: TPallet

  • storage: TStorage

  • args: TArguments[]

  • optionaloptions: { at?: At }

  • optionalat: At

  Returns Query<[...TInstructions[], { args: TArguments[]; at: At; instruction: read-storage; multi: true; pallet: TPallet; storage: TStorage }], TDescriptor>