Type alias BloombergConnection

Type declaration

• disconnect: (() => Promise<void>)

  Terminates the connection and cleans up utilized resources.

  • • (): Promise<void>

    • Terminates the connection and cleans up utilized resources.

      Returns Promise<void>

• executeApiRequest: (<T>(query, service?) => Promise<T>)

  Executes a GraphQL request to the Bloomberg Terminal Connect API.

  Please refer to Bloomberg’s Terminal Connect API documentation for more information on executing Terminal Connect API requests.

  Type Param: T

  A type that describes the requested data. This API includes a number of data types for use with this function.

  Param: query

  The GraphQL query payload to execute.

  Param: service

  The Terminal Connect API service endpoint to direct the request to. Defaults to the local service endpoint.

  Returns

  The data object of type T contained in the API response.

  • • <T>(query, service?): Promise<T>

    • Executes a GraphQL request to the Bloomberg Terminal Connect API.

      Please refer to Bloomberg’s Terminal Connect API documentation for more information on executing Terminal Connect API requests.

      Type Parameters

      • T = unknown

        A type that describes the requested data. This API includes a number of data types for use with this function.

      Parameters

      • query: string

        The GraphQL query payload to execute.
      • Optional service: TerminalConnectService

        The Terminal Connect API service endpoint to direct the request to. Defaults to the local service endpoint.

      Returns Promise<T>

      The data object of type T contained in the API response.