@types/sse
TypeScript icon, indicating that this package has built-in type declarations

0.0.0 • Public • Published

Installation

npm install --save @types/sse

Summary

This package contains type definitions for sse (https://github.com/einaros/sse.js#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sse.

index.d.ts

/// <reference types="node" />

import { EventEmitter } from "events";
import { IncomingMessage, ServerResponse } from "http";

export = SSE;

declare class SSE extends EventEmitter {
    constructor(httpServer: EventEmitter, options?: SSE.Options);

    server: EventEmitter;

    handleRequest(req: IncomingMessage, res: ServerResponse, query: string): void;
    matchesPath(queryPath: string, matchPath: string): boolean;
}

declare namespace SSE {
    interface Options {
        path?: string;
        verifyRequest?: ((req: IncomingMessage) => boolean) | null;
    }

    class Client extends EventEmitter {
        constructor(req: IncomingMessage, res: ServerResponse);

        req: IncomingMessage;
        res: ServerResponse;

        initialize(): void;
        send(event?: string | Client.SendObject, data?: string, id?: string): void;
        close(): void;
    }

    namespace Client {
        interface SendObject {
            event?: string;
            data?: string;
            id?: string;
            retry?: number;
        }
    }
}

Additional Details

  • Last updated: Tue, 21 Nov 2023 04:07:36 GMT
  • Dependencies: @types/node

Credits

These definitions were written by yutak23.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/sse

Weekly Downloads

196

Version

0.0.0

License

MIT

Unpacked Size

4.68 kB

Total Files

5

Last publish

Collaborators

  • types