Skip to content

Commit

Permalink
docs: add api extractor to util-stream
Browse files Browse the repository at this point in the history
  • Loading branch information
kuhe committed Sep 15, 2023
1 parent fbfeebe commit b01d380
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
6 changes: 0 additions & 6 deletions packages/util-stream/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,3 @@
[![NPM downloads](https://img.shields.io/npm/dm/@smithy/util-stream.svg)](https://www.npmjs.com/package/@smithy/util-stream)

Package with utilities to operate on streams.

> An internal package
## Usage

You probably shouldn't, at least directly.
4 changes: 4 additions & 0 deletions packages/util-stream/api-extractor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"extends": "../../api-extractor.packages.json",
"mainEntryPointFilePath": "./dist-types/index.d.ts"
}
1 change: 1 addition & 0 deletions packages/util-stream/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
"lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"",
"format": "prettier --config ../../prettier.config.js --ignore-path ../.prettierignore --write \"**/*.{ts,md,json}\"",
"extract:docs": "api-extractor run --local",
"test": "jest && karma start karma.conf.js",
"test:integration": "jest --config jest.config.integ.js"
},
Expand Down

0 comments on commit b01d380

Please sign in to comment.