Skip to content

Provide typescript type definitions #220

Open

Description

@Sytten

Hi!
It would be nice if you could provide a .d.ts file for typescript folks like me :)
Thanks

Activity

  1. Sytten commented on Nov 26, 2021

    @Sytten
    Author

    I did a first pass:

    declare module 'prerender-node' {
      import { NextFunction, Request, Response } from 'express';
    
      declare function prerender(
        req: Request,
        res: Response,
        next: NextFunction
      ): void;
    
      declare namespace prerender {
        type Done = (page?: { status: number; body: string | Buffer }) => void;
        type Set = {
          prerenderToken: string;
          beforeRender: (req: Request, done: Done) => void;
          afterRender: (err: any, req: Request, prerenderRes: any) => void;
          protocol: 'http' | 'https';
          host: string;
          forwardHeaders: boolean;
          prerenderServerRequestOptions: Record<string, any>;
        };
        declare function set<T extends keyof Set>(
          name: T,
          value: Set[T]
        ): typeof prerender;
    
        declare function whitelisted(
          whitelist: string | string[]
        ): typeof prerender;
        declare function blacklisted(
          blacklist: string | string[]
        ): typeof prerender;
      }
    
      export = prerender;
    }
  2. gzurbach commented on Jul 4, 2023

    @gzurbach

    @Sytten thanks for providing these definitions 👍

    Just a small correction:

    type Done = (err?: Error | null, page?: { status?: number; body?: string | Buffer }) => void;
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions