Logo for jsDocs.io

@types/conventional-changelog

  • Version 6.0.1
  • Published
  • 7.47 kB
  • 4 dependencies
  • MIT license

Install

npm i @types/conventional-changelog
yarn add @types/conventional-changelog
pnpm add @types/conventional-changelog

Overview

TypeScript definitions for conventional-changelog

Index

Functions

Namespaces

Functions

function conventionalChangelog

conventionalChangelog: <
    TCommit extends Commit = Commit,
    TContext extends WriterContext = conventionalChangelogCore.Context
>(
    options?: Options<TCommit, TContext>,
    context?: Partial<TContext>,
    gitRawCommitsOpts?: conventionalChangelogCore.GitRawCommitsOptions,
    parserOpts?: conventionalChangelogCore.ParserOptions,
    writerOpts?: conventionalChangelogCore.WriterOptions<TCommit, TContext>
) => Stream.Readable;

  • Returns a readable stream.

    Parameter options

    Parameter context

    Parameter gitRawCommitsOpts

    Parameter parserOpts

    Parameter writerOpts

Namespaces

namespace conventionalChangelog

namespace conventionalChangelog {}

    interface Options

    interface Options<
        TCommit extends Commit = Commit,
        TContext extends WriterContext = WriterContext
    > extends conventionalChangelogCore.Options<TCommit, TContext> {}

    • See the [conventional-changelog-core](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-core) docs. The API is the same with the following changes or additions:

    property preset

    preset?: string | undefined;

    • It's recommended to use a preset so you don't have to define everything yourself. Presets are names of built-in config.

      A scoped preset package such as @scope/conventional-changelog-custom-preset can be used by passing @scope/custom-preset to this option.

      Remarks

      options.config will be overwritten by the values of preset. You should use either preset or config, but not both.

    Package Files (1)

    Dependencies (4)

    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/conventional-changelog.

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