Logo for jsDocs.io

@types/jade

  • Version 0.0.31
  • Published
  • 5.75 kB
  • No dependencies
  • MIT license

Install

npm i @types/jade
yarn add @types/jade
pnpm add @types/jade

Overview

TypeScript definitions for jade

Index

Functions

Interfaces

Type Aliases

Functions

function compile

compile: (template: string, options?: JadeOptions) => JadeGenerationFunction;

    function compileClient

    compileClient: (
        template: string,
        options?: JadeOptions
    ) => JadeGenerationFunction;

      function compileClientWithDependenciesTracked

      compileClientWithDependenciesTracked: (
          template: string,
          options?: JadeOptions
      ) => { body: JadeGenerationFunction; dependencies: string[] };

        function compileFile

        compileFile: (path: string, options?: JadeOptions) => JadeGenerationFunction;

          function render

          render: (template: string, options?: JadeOptions) => string;

            function renderFile

            renderFile: (path: string, options?: JadeOptions) => string;

              Interfaces

              interface JadeOptions

              interface JadeOptions {}

                property basedir

                basedir?: string | undefined;

                  property cache

                  cache?: boolean | undefined;

                    property compileDebug

                    compileDebug?: boolean | undefined;

                      property debug

                      debug?: boolean | undefined;

                        property doctype

                        doctype?: string | undefined;

                          property filename

                          filename?: string | undefined;

                            property filters

                            filters?:
                                | {
                                      [key: string]: JadeCustomFilterFunction;
                                  }
                                | undefined;

                              property globals

                              globals?: string[] | undefined;

                                property inlineRuntimeFunctions

                                inlineRuntimeFunctions?: boolean | undefined;

                                  property name

                                  name?: string | undefined;

                                    property pretty

                                    pretty?: boolean | string | undefined;

                                      property self

                                      self?: boolean | undefined;

                                        interface TemplateLocals

                                        interface TemplateLocals {}

                                          index signature

                                          [key: string]: any;

                                            Type Aliases

                                            type JadeCustomFilterFunction

                                            type JadeCustomFilterFunction = (
                                                text: string,
                                                options: {
                                                    [key: string]: boolean;
                                                }
                                            ) => string;

                                              type JadeGenerationFunction

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

                                                Package Files (1)

                                                Dependencies (0)

                                                No dependencies.

                                                Dev Dependencies (0)

                                                No dev dependencies.

                                                Peer Dependencies (0)

                                                No peer dependencies.

                                                Badge

                                                To add a badge like this onejsDocs.io badgeto 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/jade.

                                                • Markdown
                                                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/jade)
                                                • HTML
                                                  <a href="https://www.jsdocs.io/package/@types/jade"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>