Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FactoryBase

This class supports requests to the api server of the AINFT Factory.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new FactoryBase(baseUrl: string, route: null | string, ain: default, ainize?: default): FactoryBase

Properties

ain

ain: default

The Ain object for sign and send transaction to AIN blockchain.

Optional ainize

ainize?: default

The Ainize object for send request to AIN blockchain.

baseUrl

baseUrl: string = ''

The base url of api server of AINFT Factory.

route

route: string

The subpath of api server request url.

Methods

sendFormRequest

  • sendFormRequest(method: POST | PUT, trailingUrl: string, stringFields: {}, fileFields: {}): Promise<any>

  • Sends request that include form to api server of AINFT Factory. Used to upload asset data.

    Parameters

    • method: POST | PUT

      The method of Http request.

    • trailingUrl: string

      The suffix of request url.

    • stringFields: {}

      The string fields of form.

      • [key: string]: string
    • fileFields: {}

      The file fields of form.

      • [key: string]: { buffer: Buffer; filename: string }
        • buffer: Buffer
        • filename: string

    Returns Promise<any>

    Returns response of api request.

sendRequest

  • sendRequest(method: HttpMethod, trailingUrl: string, data?: Record<string, any>): Promise<any>

  • Sends request to api server of AINFT Factory. Authenticate by signing data.

    Parameters

    • method: HttpMethod

      The method of Http request.

    • trailingUrl: string

      The suffix of request url.

    • Optional data: Record<string, any>

      The data to be included in the api request.

    Returns Promise<any>

    Returns response of api request.

sendRequestWithoutSign

  • sendRequestWithoutSign(method: HttpMethod, trailingUrl: string, data?: Record<string, any>, headers?: AxiosRequestHeaders): Promise<any>

  • Sends request to api server of AINFT Factory. Used when authentication is not required.

    Parameters

    • method: HttpMethod

      The method of Http request.

    • trailingUrl: string

      The suffix of request url.

    • Optional data: Record<string, any>

      The data to be included in the api request.

    • Optional headers: AxiosRequestHeaders

      The headers of Http api request.

    Returns Promise<any>

    Returns response of api request.

setBaseUrl

  • setBaseUrl(baseUrl: string): void

  • Sets base url.

    Parameters

    • baseUrl: string

      New base url to be set to base url of api server of AINFT Factory.

    Returns void

signData

  • signData(data: any): string | Promise<string>

  • Sign the data with the private key that the user has registered.

    Parameters

    • data: any

      The data to sign.

    Returns string | Promise<string>

    Returns signature string.

Generated using TypeDoc