@types/pollyjs__node-server v6.0.1

Installation

npm install --save @types/pollyjs__node-server

Summary

This package contains type definitions for @pollyjs/node-server (https://github.com/netflix/pollyjs/tree/master/packages/@pollyjs/node-server).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pollyjs__node-server.

index.d.ts

// Type definitions for @pollyjs/node-server 4.3
// Project: https://github.com/netflix/pollyjs/tree/master/packages/@pollyjs/node-server
// Definitions by: Offir Golan <https://github.com/offirgolan>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.4

import * as http from 'http';
import * as express from 'express';
import * as cors from 'cors';

export interface Config {
    port: number;
    quiet: boolean;
    recordingSizeLimit: string;
    recordingsDir: string;
    apiNamespace: string;
}

export interface ServerConfig extends Config {
    corsOptions?: cors.CorsOptions | undefined;
}

export const Defaults: Config;

export interface APIResponse {
    status: number;
    body?: any;
}

export class API {
    constructor(options: Pick<Config, 'recordingsDir'>);
    getRecordings(recording: string): APIResponse;
    saveRecording(recording: string, data: any): APIResponse;
    deleteRecording(recording: string): APIResponse;
    filenameFor(recording: string): string;
    respond(status: number, data?: any): APIResponse;
}

export class Server {
    config: ServerConfig;
    app: express.Express;
    server?: http.Server | undefined;

    constructor(options?: Partial<ServerConfig>);
    listen(port?: number, host?: string): http.Server;
}

export function registerExpressAPI(app: express.Express, config: Partial<Config>): void;

Additional Details

• Last updated: Thu, 08 Jul 2021 20:19:42 GMT
• Dependencies: @types/express, @types/cors
• Global values: none

Credits

These definitions were written by Offir Golan.