@microsoft/api-extractor-model 7.15.3 → 7.15.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/dist/tsdoc-metadata.json +1 -1
  2. package/package.json +31 -28
  3. package/CHANGELOG.json +0 -1565
  4. package/CHANGELOG.md +0 -653
package/dist/tsdoc-metadata.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.19.2"
8
+ "packageVersion": "7.19.4"
9
9
  }
10
10
  ]
11
11
  }
package/package.json CHANGED
@@ -1,29 +1,32 @@
1
1
  {
2
- "name": "@microsoft/api-extractor-model",
3
- "version": "7.15.3",
4
- "description": "A helper library for loading and saving the .api.json files created by API Extractor",
5
- "repository": {
6
- "type": "git",
7
- "url": "https://github.com/microsoft/rushstack.git",
8
- "directory": "apps/api-extractor-model"
9
- },
10
- "homepage": "https://api-extractor.com",
11
- "main": "lib/index.js",
12
- "typings": "dist/rollup.d.ts",
13
- "license": "MIT",
14
- "dependencies": {
15
- "@microsoft/tsdoc": "0.13.2",
16
- "@microsoft/tsdoc-config": "~0.15.2",
17
- "@rushstack/node-core-library": "3.45.0"
18
- },
19
- "devDependencies": {
20
- "@rushstack/eslint-config": "2.5.1",
21
- "@rushstack/heft": "0.43.2",
22
- "@rushstack/heft-node-rig": "1.4.3",
23
- "@types/heft-jest": "1.0.1",
24
- "@types/node": "12.20.24"
25
- },
26
- "scripts": {
27
- "build": "heft test --clean"
28
- }
29
- }
2
+ "name": "@microsoft/api-extractor-model",
3
+ "version": "7.15.4",
4
+ "description": "A helper library for loading and saving the .api.json files created by API Extractor",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/microsoft/rushstack.git",
8
+ "directory": "apps/api-extractor-model"
9
+ },
10
+ "homepage": "https://api-extractor.com",
11
+ "main": "lib/index.js",
12
+ "typings": "dist/rollup.d.ts",
13
+ "license": "MIT",
14
+ "dependencies": {
15
+ "@microsoft/tsdoc": "0.13.2",
16
+ "@microsoft/tsdoc-config": "~0.15.2",
17
+ "@rushstack/node-core-library": "3.45.1"
18
+ },
19
+ "devDependencies": {
20
+ "@rushstack/eslint-config": "2.5.2",
21
+ "@rushstack/heft": "0.44.2",
22
+ "@rushstack/heft-node-rig": "1.7.1",
23
+ "@types/heft-jest": "1.0.1",
24
+ "@types/node": "12.20.24"
25
+ },
26
+ "scripts": {
27
+ "build": "heft build --clean",
28
+ "_phase:build": "heft build --clean",
29
+ "_phase:test": "heft test --no-build"
30
+ },
31
+ "readme": "# @microsoft/api-extractor-model\n\nUse this library to read and write *.api.json files as defined by the [API Extractor](https://api-extractor.com/) tool.\nThese files are used to generate a documentation website for your TypeScript package. The files store the\nAPI signatures and doc comments that were extracted from your package.\n\nAPI documentation for this package: https://rushstack.io/pages/api/api-extractor-model/\n\n## Example Usage\n\nThe following code sample shows how to load `example.api.json`, which would be generated by API Extractor\nwhen it analyzes a hypothetical NPM package called `example`:\n\n```ts\nimport { ApiModel, ApiPackage } from '@microsoft/api-extractor-model';\n\nconst apiModel: ApiModel = new ApiModel();\nconst apiPackage: ApiPackage = apiModel.loadPackage('example.api.json');\n\nfor (const member of apiPackage.members) {\n console.log(member.displayName);\n}\n```\n\nThe `ApiModel` is acts as a container for various packages that are loaded and operated on as a group.\nFor example, a documentation tool may need to resolve `@link` references across different packages.\nIn this case we would load the various packages into the `ApiModel`, and then use\nthe `ApiModel.resolveDeclarationReference()` to resolve the `@link` targets.\n\nThe data structure forms a tree of various classes that start with the `Api` prefix. The nesting hierarchy\nmight look like this:\n\n```\n- ApiModel\n - ApiPackage\n - ApiEntryPoint\n - ApiClass\n - ApiMethod\n - ApiProperty\n - ApiEnum\n - ApiEnumMember\n - ApiInterface\n - ApiMethodSignature\n - ApiPropertySignature\n - ApiNamespace\n - (ApiClass, ApiEnum, ApiInterface, ...)\n```\n\nYou can use the `ApiItem.members` property to traverse this tree.\n\nNote that the non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\nTypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\nfeatures that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\nto extend more than one base class). The \"mixin\" is a TypeScript merged declaration with three components:\nthe function that generates a subclass, an interface that describes the members of the subclass, and\na namespace containing static members of the class.\n\n> For a complete project that uses these APIs to generate an API reference web site,\n> see the [@microsoft/api-documenter](https://www.npmjs.com/package/@microsoft/api-documenter) source code.\n\n## Links\n\n- [CHANGELOG.md](\n https://github.com/microsoft/rushstack/blob/master/apps/api-extractor-model/CHANGELOG.md) - Find\n out what's new in the latest version\n- [API Reference](https://rushstack.io/pages/api/api-extractor-model/)\n\nAPI Extractor is part of the [Rush Stack](https://rushstack.io/) family of projects.\n"
32
+ }