@types/serve-index

Install

npm i @types/serve-index

yarn add @types/serve-index

pnpm add @types/serve-index

TypeScript definitions for serve-index

serveIndex: (path: string, options?: serveIndex.Options) => Handler;

interface File {}

name: string;

stat: Stats;

interface Locals {}

directory: string;

displayIcons: boolean;

fileList: File[];

name: string;

path: string;

stat: Stats;

style: string;

viewName: string;

interface Options {}

filter?:
    | ((filename: string, index: number, files: File[], dir: string) => boolean)
    | undefined;

hidden?: boolean | undefined;

icons?: boolean | undefined;

stylesheet?: string | undefined;

template?:
    | string
    | ((locals: Locals, callback: TemplateCallback) => void)
    | undefined;

view?: string | undefined;

type TemplateCallback = (error: Error | null, htmlString?: string) => void;

No dev dependencies.

No peer dependencies.

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/serve-index.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/serve-index)

HTML

<a href="https://www.jsdocs.io/package/@types/serve-index"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>