@aerostack/sdk-web 0.1.0 → 0.1.1
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.
- package/README.md +0 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,13 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@aerostack/sdk-web* API.
|
|
4
4
|
|
|
5
|
-
[](https://www.speakeasy.com/?utm_source=@aerostack/sdk-web&utm_campaign=typescript)
|
|
6
5
|
[](https://opensource.org/licenses/MIT)
|
|
7
6
|
|
|
8
|
-
|
|
9
7
|
<br /><br />
|
|
10
8
|
> [!IMPORTANT]
|
|
11
|
-
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/aerostack/aerostack). Delete this section before > publishing to a package manager.
|
|
12
9
|
|
|
13
10
|
<!-- Start Summary [summary] -->
|
|
14
11
|
## Summary
|
|
@@ -45,7 +42,6 @@ caching, queues, storage, and AI services.
|
|
|
45
42
|
> [!TIP]
|
|
46
43
|
> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
|
|
47
44
|
|
|
48
|
-
|
|
49
45
|
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
|
50
46
|
|
|
51
47
|
### NPM
|
|
@@ -383,7 +379,6 @@ run();
|
|
|
383
379
|
* [`InvalidRequestError`](./src/sdk/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
|
|
384
380
|
* [`UnexpectedClientError`](./src/sdk/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
|
|
385
381
|
|
|
386
|
-
|
|
387
382
|
**Inherit from [`SDKBaseError`](./src/sdk/models/errors/sdkbaseerror.ts)**:
|
|
388
383
|
* [`ResponseValidationError`](./src/sdk/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.
|
|
389
384
|
|
|
@@ -524,8 +519,6 @@ const sdk = new SDK({ debugLogger: console });
|
|
|
524
519
|
```
|
|
525
520
|
<!-- End Debugging [debug] -->
|
|
526
521
|
|
|
527
|
-
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
|
528
|
-
|
|
529
522
|
# Development
|
|
530
523
|
|
|
531
524
|
## Maturity
|
|
@@ -539,4 +532,3 @@ looking for the latest version.
|
|
|
539
532
|
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.
|
|
540
533
|
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.
|
|
541
534
|
|
|
542
|
-
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@aerostack/sdk-web&utm_campaign=typescript)
|