Logo for jsDocs.io

jest-docblock

  • Version 29.7.0
  • Published
  • 8.99 kB
  • 1 dependency
  • MIT license

Install

npm i jest-docblock
yarn add jest-docblock
pnpm add jest-docblock

Overview

`jest-docblock` is a package that can extract and parse a specially-formatted comment called a "docblock" at the top of a file.

Index

Functions

Functions

function extract

extract: (contents: string) => string;

  • Copyright (c) Meta Platforms, Inc. and affiliates.

    This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

function parse

parse: (docblock: string) => Pragmas;

    function parseWithComments

    parseWithComments: (docblock: string) => { comments: string; pragmas: Pragmas };

      function print

      print: ({
          comments,
          pragmas,
      }: {
          comments?: string;
          pragmas?: Pragmas;
      }) => string;

        function strip

        strip: (contents: string) => string;

          Package Files (1)

          Dependencies (1)

          Dev Dependencies (1)

          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/jest-docblock.

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