bit-bin
Version:
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="apache" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a> <a href="https://github.com/teambit/bit/blob/master/CONTRIBUTING.md"><img alt="prs" src="https://img.shields.io/b
34 lines (33 loc) • 790 B
TypeScript
import { PathLinux } from '../utils/path';
import { Example } from './example-tag-parser';
export declare type Method = {
name: string;
description: string;
args: [];
access: 'public' | 'private' | '';
returns: {};
modifiers: [];
};
export declare type PropDefaultValue = {
value: string;
computed: boolean;
};
export declare type DocProp = {
name: string;
description: string;
required: boolean;
type: string;
defaultValue: PropDefaultValue;
};
export declare type Doclet = {
filePath: PathLinux;
name: string;
description: string;
args?: Record<string, any>[];
returns?: Record<string, any>;
access?: string;
examples?: Example[];
methods?: Method[];
properties?: DocProp[];
static?: boolean;
};