@types/conventional-changelog/index.d.ts

TypeScript definitions for conventional-changelog

/// <reference types="node" />

import conventionalChangelogCore from "conventional-changelog-core";
import { Context as WriterContext } from "conventional-changelog-writer";
import { Commit } from "conventional-commits-parser";
import Stream = require("stream");

/**
 * Returns a readable stream.
 *
 * @param options
 * @param context
 * @param gitRawCommitsOpts
 * @param parserOpts
 * @param writerOpts
 */
declare function 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;

declare namespace conventionalChangelog {
    /**
     * 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:
     */
    interface Options<TCommit extends Commit = Commit, TContext extends WriterContext = WriterContext>
        extends conventionalChangelogCore.Options<TCommit, TContext>
    {
        /**
         * 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.
         */
        preset?: string | undefined;
    }
}

type Options<TCommit extends Commit = Commit, TContext extends WriterContext = WriterContext> =
    conventionalChangelog.Options<TCommit, TContext>;

export default conventionalChangelog;