@ts2doc/storybook-addon

Storybook addon to document exported declarations from ts files

Installation

Yarn

yarn add -D @ts2doc/storybook-addon

NPM

npm install --save-dev @ts2doc/storybook-addon

Example

Is displayed from the following TypeScript interface:

/**
 * A movie is a piece of media that is intended to be viewed as a film.
 * @link https://wikipedia.org/wiki/Film | Useful link
 */
export interface Movie extends Media {
    /**
     * The title of the movie
     */
    readonly title: string;
    /**
     * The year the movie was released
     * @type {Date}
     */
    year: number;
    /**
     * The rating of the movie
     * @link https://wikipedia.org/wiki/Film_rating_system Film rating system
     * @default 0
     */
    rating?: number;
    genres: string[];
    /**
     * The actors in the movie
     */
    cast: Actor[];
    /**
     * @deprecated
     */
    director: Director;
}

Usage

See @ts2doc documentation.