@types/supertest/index.d.ts

TypeScript definitions for supertest

import superagent = require("superagent");
import stAgent = require("./lib/agent");
import STest = require("./lib/test");
import cookies = require("./lib/cookies");
import { AgentOptions as STAgentOptions, App } from "./types";

declare const supertest: supertest.SuperTestStatic;

declare namespace supertest {
    type Response = superagent.Response;

    type Request = superagent.SuperAgentRequest;

    type CallbackHandler = superagent.CallbackHandler;

    // eslint-disable-next-line @typescript-eslint/no-empty-interface
    interface Test extends STest {}

    // eslint-disable-next-line @typescript-eslint/no-empty-interface
    interface Agent extends stAgent {}

    interface Options {
        http2?: boolean;
    }

    type AgentOptions = STAgentOptions;

    type SuperTest<Req extends Test = Test> = superagent.SuperAgent<Req>;

    type SuperAgentTest = SuperTest<Test>;

    type CustomAssertionCookie = cookies.CustomAssertionCookie;

    interface SuperTestStatic {
        (app: App, options?: STAgentOptions): stAgent;
        Test: typeof STest;
        agent: typeof stAgent & ((app?: App, options?: STAgentOptions) => InstanceType<typeof stAgent>);
        cookies: typeof cookies;
    }
}

export = supertest;