@aptos-labs/ts-sdk - v3.1.1
    Preparing search index...

    Function post

    • post<Req extends {}, Res extends {}>(
          options: PostRequestOptions,
      ): Promise<AptosResponse<Req, Res>>

      Executes a POST request to the specified URL with the provided options.

      Type Parameters

      • Req extends {}
      • Res extends {}

      Parameters

      • options: PostRequestOptions

        The options for the POST request.

        Options for making a POST request, including the API client configuration.

        • OptionalacceptType?: MimeType

          The accepted content type of the response of the API

        • aptosConfig: AptosConfig

          The config for the API client

        • Optionalbody?: any

          The body of the request, should match the content type of the request

        • OptionalcontentType?: MimeType

          The content type of the request body

        • originMethod: string

          The name of the API method

        • Optionaloverrides?: ClientConfig

          Specific client overrides for this request to override aptosConfig

        • Optionalparams?: Record<string, string | AnyNumber | boolean | undefined>

          The query parameters for the request

        • path: string

          The URL path to the API method

        • type: AptosApiType

          The type of API endpoint to call e.g. fullnode, indexer, etc

      Returns Promise<AptosResponse<Req, Res>>

      The response from the POST request.