@smithy/eventstream-serde-node
Advanced tools
+7
-8
| { | ||
| "name": "@smithy/eventstream-serde-node", | ||
| "version": "4.2.12", | ||
| "version": "4.2.13", | ||
| "scripts": { | ||
| "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types && yarn build:types:downlevel'", | ||
| "build:cjs": "node ../../scripts/inline eventstream-serde-node", | ||
| "build:es": "yarn g:tsc -p tsconfig.es.json", | ||
| "build": "concurrently 'yarn:build:types' 'yarn:build:es:cjs'", | ||
| "build:es:cjs": "yarn g:tsc -p tsconfig.es.json && node ../../scripts/inline eventstream-serde-node", | ||
| "build:types": "yarn g:tsc -p tsconfig.types.json", | ||
| "build:types:downlevel": "premove dist-types/ts3.4 && downlevel-dts dist-types dist-types/ts3.4", | ||
| "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz", | ||
| "clean": "premove dist-cjs dist-es dist-types tsconfig.cjs.tsbuildinfo tsconfig.es.tsbuildinfo tsconfig.types.tsbuildinfo", | ||
| "format": "prettier --config ../../prettier.config.js --ignore-path ../../.prettierignore --write \"**/*.{ts,md,json}\"", | ||
| "lint": "eslint -c ../../.eslintrc.js \"src/**/*.ts\"", | ||
| "format": "prettier --config ../../prettier.config.js --ignore-path ../../.prettierignore --write \"**/*.{ts,md,json}\"", | ||
| "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz", | ||
| "test": "exit 0" | ||
@@ -26,4 +25,4 @@ }, | ||
| "dependencies": { | ||
| "@smithy/eventstream-serde-universal": "^4.2.12", | ||
| "@smithy/types": "^4.13.1", | ||
| "@smithy/eventstream-serde-universal": "^4.2.13", | ||
| "@smithy/types": "^4.14.0", | ||
| "tslib": "^2.6.2" | ||
@@ -30,0 +29,0 @@ }, |
+10
-3
@@ -6,6 +6,13 @@ # @smithy/eventstream-serde-node | ||
| > An internal package | ||
| ### :warning: Internal API :warning: | ||
| ## Usage | ||
| > This is an internal package. | ||
| > That means this is used as a dependency for other, public packages, but | ||
| > should not be taken directly as a dependency in your application's `package.json`. | ||
| You probably shouldn't, at least directly. | ||
| > If you are updating the version of this package, for example to bring in a | ||
| > bug-fix, you should do so by updating your application lockfile with | ||
| > e.g. `npm up @scope/package` or equivalent command in another | ||
| > package manager, rather than taking a direct dependency. | ||
| --- |
| import { Decoder, Encoder, EventStreamMarshaller as IEventStreamMarshaller, Message } from "@smithy/types"; | ||
| import { Readable } from "stream"; | ||
| /** | ||
| * @internal | ||
| */ | ||
| export interface EventStreamMarshaller extends IEventStreamMarshaller { | ||
| } | ||
| /** | ||
| * @internal | ||
| */ | ||
| export interface EventStreamMarshallerOptions { | ||
| utf8Encoder: Encoder; | ||
| utf8Decoder: Decoder; | ||
| } | ||
| /** | ||
| * @internal | ||
| */ | ||
| export declare class EventStreamMarshaller { | ||
| private readonly universalMarshaller; | ||
| constructor({ utf8Encoder, utf8Decoder }: EventStreamMarshallerOptions); | ||
| deserialize<T>(body: Readable, deserializer: (input: Record<string, Message>) => Promise<T>): AsyncIterable<T>; | ||
| serialize<T>(input: AsyncIterable<T>, serializer: (event: T) => Message): Readable; | ||
| } |
| /** | ||
| * @internal | ||
| */ | ||
| export * from "./EventStreamMarshaller"; | ||
| /** | ||
| * @internal | ||
| */ | ||
| export * from "./provider"; |
| import { EventStreamSerdeProvider } from "@smithy/types"; | ||
| /** NodeJS event stream utils provider */ | ||
| export declare const eventStreamSerdeProvider: EventStreamSerdeProvider; |
| import { Readable } from "stream"; | ||
| /** | ||
| * Convert object stream piped in into an async iterable. This | ||
| * daptor should be deprecated when Node stream iterator is stable. | ||
| * Caveat: this adaptor won't have backpressure to inwards stream | ||
| * | ||
| * Reference: https://nodejs.org/docs/latest-v11.x/api/stream.html#stream_readable_symbol_asynciterator | ||
| */ | ||
| /** | ||
| * @internal | ||
| */ | ||
| export declare function readabletoIterable<T>(readStream: Readable): AsyncIterable<T>; |
18
63.64%19190
-5.72%12
-25%143
-24.34%