@microsoft/api-extractor/lib/IDocItem.d.ts

Validatation, documentation, and auditing for the exported API of a TypeScript package

import { IDocElement } from './IDocElement';
/**
 * Whether the function is public, private, or protected.
 */
export declare enum AccessModifier {
    public = 0,
    private = 1,
    protected = 2,
    /**
     * Exmpty string, no access modifier.
     */
    '' = 3,
}
/**
 * The enum value of an IDocEnum.
 *
 * IDocEnumValue does not extend the IDocITem base class
 * because the summary is not required.
 */
export interface IDocEnumValue {
    value: string;
    summary?: IDocElement[];
    remarks?: IDocElement[];
    deprecatedMessage?: IDocElement[];
}
/**
 * Parameter Doc item.
 */
export interface IDocParam {
    /**
     * the parameter name
     */
    name: string;
    /**
     * describes the parameter
     */
    description: IDocElement[];
    /**
     * Whether the parameter is optional
     */
    isOptional: boolean;
    /**
     * Whether the parameter has the '...' spread suffix
     */
    isSpread: boolean;
    /**
     * The data type of the parameter
     */
    type: string;
}
/**
 * Return value of a method or function.
 */
export interface IDocReturnValue {
    /**
     * The data type returned by the function
     */
    type: string;
    /**
     * Describes the return value
     */
    description: IDocElement[];
}
/**
 * DocItems are the typescript adaption of the json schemas
 * defined in API-json-schema.json. IDocElement is a component
 * for IDocItems because they represent formated rich text.
 *
 * This is the base class for other DocItem types.
 */
export interface IDocBase {
    /**
     * kind of DocItem. Ex: 'class', 'Enum', 'Function', etc.
     */
    kind: string;
    isBeta: boolean;
    summary: IDocElement[];
    remarks?: IDocElement[];
    deprecatedMessage?: IDocElement[];
}
/**
 * A property of a TypeScript class or interface
 */
export interface IDocProperty extends IDocBase {
    /**
     * {@inheritdoc IDocBase.kind}
     */
    kind: 'property';
    /**
     * For an interface member, whether it is optional
     */
    isOptional: boolean;
    /**
     * Whether the property is read-only
     */
    isReadOnly: boolean;
    /**
     * For a class member, whether it is static
     */
    isStatic: boolean;
    /**
     * The data type of this property
     */
    type: string;
}
/**
 * A member function of a typescript class or interface.
 */
export interface IDocMethod extends IDocBase {
    /**
     * {@inheritdoc IDocBase.kind}
     */
    kind: 'method';
    /**
     * a text summary of the method definition
     */
    signature: string;
    /**
     * the access modifier of the method
     */
    accessModifier: AccessModifier;
    /**
     * for an interface member, whether it is optional
     */
    isOptional: boolean;
    /**
     * for a class member, whether it is static
     */
    isStatic: boolean;
    /**
     * a mapping of parameter name to IDocParam
     */
    parameters: {
        [name: string]: IDocParam;
    };
    /**
     * describes the return value of the method
     */
    returnValue: IDocReturnValue;
}
/**
 * A Typescript function.
 */
export interface IDocFunction extends IDocBase {
    /**
     * {@inheritdoc IDocBase.kind}
     */
    kind: 'function';
    /**
     * parameters of the function
     */
    parameters: {
        [name: string]: IDocParam;
    };
    /**
     * a description of the return value
     */
    returnValue: IDocReturnValue;
}
/**
 * IDocClass represetns an exported class.
 *
 */
export interface IDocClass extends IDocBase {
    /**
     * {@inheritdoc IDocBase.kind}
     */
    kind: 'class';
    /**
     * Can be a combination of methods and/or properties
     */
    members: {
        [name: string]: IDocMember;
    };
    /**
     * Interfaces implemented by this class
     */
    implements?: string;
    /**
     * The base class for this class
     */
    extends?: string;
    /**
     * Generic type parameters for this class
     */
    typeParameters?: string[];
}
/**
 * IDocEnum represents an exported enum.
 */
export interface IDocEnum extends IDocBase {
    /**
     * {@inheritdoc IDocBase.kind}
     */
    kind: 'enum';
    values: IDocEnumValue[];
}
/**
 * IDocInterface represents an exported interface.
 */
export interface IDocInterface extends IDocBase {
    /**
     * {@inheritdoc IDocBase.kind}
     */
    kind: 'interface';
    /**
     * A mapping from the name of a member API to its IDocMember
     */
    members: {
        [name: string]: IDocMember;
    };
    /**
     * Interfaces implemented by this interface
     */
    implements?: string;
    /**
     * The base interface for this interface
     */
    extends?: string;
    /**
     * Generic type parameters for this interface
     */
    typeParameters?: string[];
}
/**
 * IDocPackage is an object contaning the exported
 * definions of this API package. The exports can include:
 * classes, interfaces, enums, functions.
 */
export interface IDocPackage {
    /**
    * {@inheritdoc IDocBase.kind}
    */
    kind: 'package';
    /**
     * IDocItems of exported API items
     */
    exports: {
        [name: string]: IDocItem;
    };
    /**
     * The following are needed so that this interface and can share
     * common properties with others that extend IDocBase. The IDocPackage
     * does not extend the IDocBase because a summary is not required for
     * a package.
     */
    isBeta?: boolean;
    summary?: IDocElement[];
    remarks?: IDocElement[];
    deprecatedMessage?: IDocElement[];
}
/**
 * A member of a class.
 */
export declare type IDocMember = IDocProperty | IDocMethod;
export declare type IDocItem = IDocProperty | IDocMember | IDocFunction | IDocClass | IDocEnum | IDocInterface | IDocPackage;