Class HttpRequester

Index

Constructors

Properties

Methods

buildError deserialize query stream escapeUrlSlug is404Error

Constructors

constructor

new HttpRequester(
token: string,
options: { prefix?: string; url: string },
): HttpRequester
Parameters
- token: string
- options: { prefix?: string; url: string }
Returns HttpRequester
- Defined in packages/agent-client/src/http-requester.ts:27

Properties

`Protected` `Readonly`deserializer

deserializer: Deserializer

Methods

`Protected`buildError

buildError(status: number, body: unknown, text?: string): AgentHttpError
Parameters
- status: number
- body: unknown
- Optionaltext: string
Returns AgentHttpError
- Defined in packages/agent-client/src/http-requester.ts:36

`Protected`deserialize

deserialize<Data>(
    body: unknown,
    text: string,
    skipDeserialization?: boolean,
): Promise<Data>
Type Parameters
- Data
Parameters
- body: unknown
- text: string
- OptionalskipDeserialization: boolean
Returns Promise<Data>
- Defined in packages/agent-client/src/http-requester.ts:42

query

query<Data = unknown>(
    __namedParameters: {
        body?: Record<string, unknown>;
        contentType?: "application/json" | "text/csv";
        maxTimeAllowed?: number;
        method: "post" | "get" | "put" | "delete";
        path: string;
        query?: Record<string, unknown>;
        skipDeserialization?: boolean;
    },
): Promise<Data>
Type Parameters
- Data = unknown
Parameters
- __namedParameters: {
      body?: Record<string, unknown>;
      contentType?: "application/json" | "text/csv";
      maxTimeAllowed?: number;
      method: "post" | "get" | "put" | "delete";
      path: string;
      query?: Record<string, unknown>;
      skipDeserialization?: boolean;
  }
Returns Promise<Data>
- Defined in packages/agent-client/src/http-requester.ts:56

stream

stream(
    __namedParameters: {
        contentType: "text/csv";
        maxTimeAllowed?: number;
        path: string;
        query?: Record<string, unknown>;
        stream: WriteStream;
    },
): Promise<void>
Parameters
- __namedParameters: {
      contentType: "text/csv";
      maxTimeAllowed?: number;
      path: string;
      query?: Record<string, unknown>;
      stream: WriteStream;
  }
Returns Promise<void>
- Defined in packages/agent-client/src/http-requester.ts:99

`Static`escapeUrlSlug

escapeUrlSlug(name: string): string
Parameters
- name: string
Returns string
- Defined in packages/agent-client/src/http-requester.ts:133

`Static`is404Error

is404Error(error: unknown): boolean
Parameters
- error: unknown
Returns boolean
- Defined in packages/agent-client/src/http-requester.ts:137