# @types/jade

> TypeScript definitions for jade

Latest version **0.0.34** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/jade
pnpm add @types/jade
yarn add @types/jade
bun add @types/jade
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.34 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51441 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/jade
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jade
- npm.io page: https://npm.io/package/@types/jade

## Recent versions

- 0.0.34 (latest) — 2023-11-07
- 0.0.31 (ts3.6) — 2021-07-08
- 0.0.30 (ts2.0) — 2016-12-29
- 0.0.33 — 2023-10-18
- 0.0.32 — 2023-09-15
- 0.0.29 — 2016-09-19
- 0.0.28 — 2016-07-14
- 0.0.27-alpha — 2016-07-08
- 0.0.26-alpha — 2016-07-04
- 0.0.25-alpha — 2016-07-02
- 0.0.24-alpha — 2016-07-01
- 0.0.23-alpha — 2016-07-01
- 0.0.22-alpha — 2016-05-25
- 0.0.21-alpha — 2016-05-20
- 0.0.16-alpha — 2016-05-19
- … 1 more at https://npm.io/package/@types/jade/versions

## README

# Installation
> `npm install --save @types/jade`

# Summary
This package contains type definitions for jade (https://github.com/jadejs/jade).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jade.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jade/index.d.ts)
````ts
export type JadeCustomFilterFunction = (text: string, options: {
    [key: string]: boolean;
}) => string;

export interface JadeOptions {
    filename?: string | undefined;
    basedir?: string | undefined;
    doctype?: string | undefined;
    pretty?: boolean | string | undefined;
    filters?: {
        [key: string]: JadeCustomFilterFunction;
    } | undefined;
    self?: boolean | undefined;
    debug?: boolean | undefined;
    compileDebug?: boolean | undefined;
    globals?: string[] | undefined;
    cache?: boolean | undefined;
    inlineRuntimeFunctions?: boolean | undefined;
    name?: string | undefined;
}

export interface TemplateLocals {
    [key: string]: any;
}

export type JadeGenerationFunction = (locals?: TemplateLocals) => string;

export declare function compile(template: string, options?: JadeOptions): JadeGenerationFunction;
export declare function compileFile(path: string, options?: JadeOptions): JadeGenerationFunction;
export declare function compileClient(template: string, options?: JadeOptions): JadeGenerationFunction;
export declare function compileClientWithDependenciesTracked(template: string, options?: JadeOptions): {
    body: JadeGenerationFunction;
    dependencies: string[];
};
export declare function render(template: string, options?: JadeOptions): string;
export declare function renderFile(path: string, options?: JadeOptions): string;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

# Credits
These definitions were written by [Panu Horsmalahti](https://github.com/panuhorsmalahti).

---
_Source: https://npm.io/package/@types/jade · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._