docs: add api extractor to util-stream (#935)

smithy-lang · Sep 15, 2023 · 99fc0b4 · 99fc0b4
1 parent fbfeebe
commit 99fc0b4
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/.changeset/happy-badgers-travel.md b/.changeset/happy-badgers-travel.md
@@ -0,0 +1,5 @@
+---
+"@smithy/util-stream": patch
+---
+
+util-stream api extraction added
diff --git a/packages/util-stream/README.md b/packages/util-stream/README.md
@@ -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.
diff --git a/packages/util-stream/api-extractor.json b/packages/util-stream/api-extractor.json
@@ -0,0 +1,4 @@
+{
+  "extends": "../../api-extractor.packages.json",
+  "mainEntryPointFilePath": "./dist-types/index.d.ts"
+}
diff --git a/packages/util-stream/package.json b/packages/util-stream/package.json
@@ -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"
   },