Logo for jsDocs.io

definition-header

  • Version 0.6.0
  • Published
  • 4 dependencies
  • MIT license

Install

npm i definition-header
yarn add definition-header
pnpm add definition-header

Overview

DefinitelyTyped definition header tools

Index

Variables

Functions

Interfaces

Namespaces

Variables

variable parts

let parts: typeof parseLax;

    Functions

    function assert

    assert: (header: model.Header) => model.Header;

      function isPartial

      isPartial: (source: string) => boolean;

        function parse

        parse: (source: string) => Result;

          function stringify

          stringify: (header: model.Header) => string[];

            Interfaces

            interface Result

            interface ParseResult {}

              property column

              column?: number;

                property details

                details?: string;

                  property index

                  index?: number;

                    property line

                    line?: number;

                      property message

                      message?: string;

                        property success

                        success: boolean;

                          property value

                          value?: model.Header;

                            Namespaces

                            namespace model

                            module 'src/model.d.ts' {}

                              interface Author

                              interface Author extends Person {}

                                interface Header

                                interface Header {}

                                  property authors

                                  authors: Author[];

                                    property label

                                    label: Label;

                                      property project

                                      project: Project[];

                                        property repository

                                        repository: Repository;

                                          interface Label

                                          interface Label {}

                                            property name

                                            name: string;

                                              property version

                                              version: string;

                                                interface Person

                                                interface Person {}

                                                  property name

                                                  name: string;

                                                    property url

                                                    url: string;

                                                      interface Project

                                                      interface Project {}

                                                        property url

                                                        url: string;

                                                          interface Repository

                                                          interface Repository {}

                                                            property url

                                                            url: string;

                                                              namespace utils

                                                              module 'src/utils.d.ts' {}

                                                                function charPointer

                                                                charPointer: (column: number) => string;

                                                                  function getLinesAt

                                                                  getLinesAt: (stream: string, start: number, end?: number) => string[];

                                                                    function highlightPos

                                                                    highlightPos: (stream: string, line: number, column?: number) => string;

                                                                      function linkPos

                                                                      linkPos: (
                                                                          dest: string,
                                                                          line?: number,
                                                                          column?: number,
                                                                          oneBased?: boolean
                                                                      ) => string;

                                                                        function untrail

                                                                        untrail: (str: string) => string;

                                                                          Package Files (5)

                                                                          Dependencies (4)

                                                                          Dev Dependencies (25)

                                                                          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/definition-header.

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