PlatformTest

@tsed/platform-http

Usage

import { PlatformTest } from "@tsed/platform/platform-http/src/types/testing/PlatformTest";

See /packages/platform/platform-http/src/types/testing/PlatformTest.ts.

Overview

class PlatformTest extends DITest {
    static create(settings?: Partial<TsED.Configuration>): Promise<void>;
    static createInjector(settings?: any): InjectorService;
    static bootstrap(mod: any, { listen, ...settings }?: Partial<PlatformBuilderSettings & {
        listen: boolean;
    }>): () => Promise<void>;
    static inject<T>(targets: any[], func: (...args: any[]) => Promise<T> | T): () => Promise<T>;
    static callback(): RequestListener<typeof IncomingMessage, typeof ServerResponse>;
    static createRequest(options?: any): any;
    static createResponse(options?: any): any;
    static createRequestContext(options?: Partial<PlatformContextOptions & any>): PlatformContext<import("../index.js").PlatformRequest<any>, import("../index.js").PlatformResponse<any>>;
}

static create

static create(settings?: Partial<TsED.Configuration>): Promise<void>;

static createInjector

static createInjector(settings?: any): InjectorService;

Create a new injector with the right default services

static bootstrap

static bootstrap(mod: any, { listen, ...settings }?: Partial<PlatformBuilderSettings & {
     listen: boolean;
 }>): () => Promise<void>;

Load the server silently without listening port and configure it on test profile.

static inject

static inject<T>(targets: any[], func: (...args: any[]) => Promise<T> | T): () => Promise<T>;

It injects services into the test function where you can alter, spy on, and manipulate them.

The inject function has two parameters

• an array of Service dependency injection tokens,
• a test function whose parameters correspond exactly to each item in the injection token array.

static callback

static callback(): RequestListener<typeof IncomingMessage, typeof ServerResponse>;

Return the raw application (express or koa). Use this callback with SuperTest.

let request: SuperTest.Agent;
beforeEach(PlatformTest.bootstrap(Server, {
  mount: {
    "/rest": [ProductsController]
  }
}));
beforeEach(() => {
  request = SuperTest(PlatformTest.callback());
});

static createRequest

static createRequest(options?: any): any;

static createResponse

static createResponse(options?: any): any;

static createRequestContext

static createRequestContext(options?: Partial<PlatformContextOptions & any>): PlatformContext<import("../index.js").PlatformRequest<any>, import("../index.js").PlatformResponse<any>>;