npm - @s2-dev/streamstore - Versions diffs - 0.15.1 → 0.15.3 - Mend

@s2-dev/streamstore 0.15.1 → 0.15.3

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 (316) hide show

package/README.md CHANGED Viewed

@@ -1,6 +1,6 @@
 # streamstore
-Developer-friendly & type-safe Typescript SDK specifically catered to leverage *streamstore* API.
+Developer-friendly & type-safe TypeScript SDK specifically catered to leverage *streamstore* API.
 <div align="left">
     <a href="https://www.speakeasy.com/?utm_source=streamstore&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -235,20 +235,20 @@ run();
 * [listBasins](docs/sdks/basins/README.md#listbasins) - List basins.
 * [createBasin](docs/sdks/basins/README.md#createbasin) - Create a basin.
-* [getBasinConfig](docs/sdks/basins/README.md#getbasinconfig) - Get basin config.
+* [getBasinConfig](docs/sdks/basins/README.md#getbasinconfig) - Get basin configuration.
 * [createOrReconfigureBasin](docs/sdks/basins/README.md#createorreconfigurebasin) - Create or reconfigure a basin.
 * [deleteBasin](docs/sdks/basins/README.md#deletebasin) - Delete a basin.
 * [reconfigureBasin](docs/sdks/basins/README.md#reconfigurebasin) - Reconfigure a basin.
 ### [metrics](docs/sdks/metrics/README.md)
-* [accountMetrics](docs/sdks/metrics/README.md#accountmetrics) - Get account level metrics.
-* [basinMetrics](docs/sdks/metrics/README.md#basinmetrics) - Get metrics for a basin.
-* [streamMetrics](docs/sdks/metrics/README.md#streammetrics) - Get metrics for a stream.
+* [accountMetrics](docs/sdks/metrics/README.md#accountmetrics) - Account-level metrics.
+* [basinMetrics](docs/sdks/metrics/README.md#basinmetrics) - Basin-level metrics.
+* [streamMetrics](docs/sdks/metrics/README.md#streammetrics) - Stream-level metrics.
 ### [records](docs/sdks/records/README.md)
-* [read](docs/sdks/records/README.md#read) - Retrieve records.
+* [read](docs/sdks/records/README.md#read) - Read records.
 * [append](docs/sdks/records/README.md#append) - Append records.
 * [checkTail](docs/sdks/records/README.md#checktail) - Check the tail.
@@ -286,15 +286,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`basinsCreateBasin`](docs/sdks/basins/README.md#createbasin) - Create a basin.
 - [`basinsCreateOrReconfigureBasin`](docs/sdks/basins/README.md#createorreconfigurebasin) - Create or reconfigure a basin.
 - [`basinsDeleteBasin`](docs/sdks/basins/README.md#deletebasin) - Delete a basin.
-- [`basinsGetBasinConfig`](docs/sdks/basins/README.md#getbasinconfig) - Get basin config.
+- [`basinsGetBasinConfig`](docs/sdks/basins/README.md#getbasinconfig) - Get basin configuration.
 - [`basinsListBasins`](docs/sdks/basins/README.md#listbasins) - List basins.
 - [`basinsReconfigureBasin`](docs/sdks/basins/README.md#reconfigurebasin) - Reconfigure a basin.
-- [`metricsAccountMetrics`](docs/sdks/metrics/README.md#accountmetrics) - Get account level metrics.
-- [`metricsBasinMetrics`](docs/sdks/metrics/README.md#basinmetrics) - Get metrics for a basin.
-- [`metricsStreamMetrics`](docs/sdks/metrics/README.md#streammetrics) - Get metrics for a stream.
+- [`metricsAccountMetrics`](docs/sdks/metrics/README.md#accountmetrics) - Account-level metrics.
+- [`metricsBasinMetrics`](docs/sdks/metrics/README.md#basinmetrics) - Basin-level metrics.
+- [`metricsStreamMetrics`](docs/sdks/metrics/README.md#streammetrics) - Stream-level metrics.
 - [`recordsAppend`](docs/sdks/records/README.md#append) - Append records.
 - [`recordsCheckTail`](docs/sdks/records/README.md#checktail) - Check the tail.
-- [`recordsRead`](docs/sdks/records/README.md#read) - Retrieve records.
+- [`recordsRead`](docs/sdks/records/README.md#read) - Read records.
 - [`streamsCreateOrReconfigureStream`](docs/sdks/streams/README.md#createorreconfigurestream) - Create or reconfigure a stream.
 - [`streamsCreateStream`](docs/sdks/streams/README.md#createstream) - Create a stream.
 - [`streamsDeleteStream`](docs/sdks/streams/README.md#deletestream) - Delete a stream.
@@ -488,7 +488,7 @@ run();
 ### Error Classes
 **Primary errors:**
 * [`S2Error`](./src/models/errors/s2error.ts): The base class for HTTP error responses.
-  * [`ErrorResponse`](docs/models/errors/errorresponse.md): .
+  * [`ErrorResponse`](./src/models/errors/errorresponse.ts): .
 <details><summary>Less common errors (9)</summary>
@@ -503,9 +503,9 @@ run();
 **Inherit from [`S2Error`](./src/models/errors/s2error.ts)**:
-* [`FencingToken`](docs/models/errors/fencingtoken.md): Fencing token did not match. The expected fencing token is returned. Status code `412`. Applicable to 1 of 21 methods.*
-* [`SeqNum`](docs/models/errors/seqnum.md): Sequence number did not match the tail of the stream. The expected next sequence number is returned. Status code `412`. Applicable to 1 of 21 methods.*
-* [`TailResponse`](docs/models/errors/tailresponse.md): . Status code `416`. Applicable to 1 of 21 methods.*
+* [`FencingToken`](./src/models/errors/fencingtoken.ts): Fencing token did not match. The expected fencing token is returned. Status code `412`. Applicable to 1 of 21 methods.*
+* [`SeqNum`](./src/models/errors/seqnum.ts): Sequence number did not match the tail of the stream. The expected next sequence number is returned. Status code `412`. Applicable to 1 of 21 methods.*
+* [`TailResponse`](./src/models/errors/tailresponse.ts): . Status code `416`. Applicable to 1 of 21 methods.*
 * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
 </details>
@@ -647,4 +647,4 @@ looking for the latest version.
 While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
 We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
-### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=streamstore&utm_campaign=typescript)
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=streamstore&utm_campaign=)