@microsoft/api-extractor/lib/example2-output.api.ts

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

// WARNING: Unable to find a documentation file ("es6-collections.api.json") for the referenced package
interface IExternalPackageLookupInheritDoc {
}

// WARNING: __constructor has incomplete type information
class IncompleteTypeConstructor {
}

enum inheritDisplayMode {
}

enum inheritDisplayModeError {
}

enum inheritDisplayModeErrorDeprecated {
}

// @deprecated
enum inheritDisplayModeNoErrorDeprecated {
}

// WARNING: propertyWithIncompleteType has incomplete type information
// WARNING: methodWithIncompleteParamTypes has incomplete type information
// WARNING: methodWithIncompleteReturnType has incomplete type information
// @public
class MyDocumentedClass {
  // (undocumented)
  constructor();
  // WARNING: The name "$unallowedName" contains unsupported characters; API names should use only letters, numbers, and underscores
  public $unallowedName: string;
  // @beta (undocumented)
  public betaTagmissingParam: string;
  public fieldWithBadTag: string;
  // @deprecated
  public fieldWithInvalidInlineTag: string;
  public fieldWithValidEscapedBraces: string;
  public linkTagMissingParam: string;
  public methodWithTwoParams(param1: number, param2: string): string;
  public methodWithTypeLiterals: {
    name: string;
    obj: MyDocumentedClass;
  }
  public methodWithTypeReferences(param: MyDocumentedClass[]): MyDocumentedClass;
  public propertyTypeLiteralIncompleteTypes: {
    // WARNING: name has incomplete type information
    address: string;
  }
}

// WARNING: Unable to find referenced export "@microsoft/sp-core-library:Display""
enum packageLocatedButExportNotFound {
}

enum TestMissingCommentStar {
}

// WARNING: functionWithIncompleteReturnType has incomplete type information
// WARNING: functionWithIncompleteParameterType has incomplete type information