@speakeasy-api/speakeasy-client-sdk-typescript
Advanced tools
<!-- Start SDK Installation [installation] --> ## SDK Installation
npm add @speakeasy-api/speakeasy-client-sdk-typescript
pnpm add @speakeasy-api/speakeasy-client-sdk-typescript
bun add @speakeasy-api/speakeasy-client-sdk-typescript
yarn add @speakeasy-api/speakeasy-client-sdk-typescript zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy();
async function run() {
const result = await speakeasy.apis.getApis({});
// Handle the result
console.log(result);
}
run();
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.SDKError | 4xx-5xx | / |
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { SDKValidationError } from "@speakeasy-api/speakeasy-client-sdk-typescript/sdk/models/errors";
const speakeasy = new Speakeasy();
async function run() {
let result;
try {
result = await speakeasy.apis.deleteApi({
apiID: "<value>",
versionID: "<value>",
});
} catch (err) {
switch (true) {
case err instanceof SDKValidationError: {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
default: {
throw err;
}
}
}
// Handle the result
console.log(result);
}
run();
You can override the default server globally by passing a server name to the server optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
| Name | Server | Variables |
|---|---|---|
prod | https://api.prod.speakeasyapi.dev | None |
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
server: "prod",
});
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<value>",
versionID: "<value>",
});
// Handle the result
console.log(result);
}
run();
The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
serverURL: "https://api.prod.speakeasyapi.dev",
});
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<value>",
versionID: "<value>",
});
// Handle the result
console.log(result);
}
run();
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { HTTPClient } from "@speakeasy-api/speakeasy-client-sdk-typescript/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new Speakeasy({ httpClient });
This SDK supports the following security schemes globally:
| Name | Type | Scheme |
|---|---|---|
apiKey | apiKey | API key |
bearer | http | HTTP Bearer |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy();
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<value>",
versionID: "<value>",
});
// Handle the result
console.log(result);
}
run();
A parameter is configured globally. This parameter may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, This global value will be used as the default on the operations that use it. When such operations are called, there is a place in each to override the global value, if needed.
For example, you can set workspaceID to "<value>" at SDK initialization and then you do not have to pass the same value on calls to operations like getWorkspace. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameter is available.
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceID | string | The workspaceID parameter. |
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy();
async function run() {
const result = await speakeasy.workspaces.getWorkspace({});
// Handle the result
console.log(result);
}
run();
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy();
async function run() {
const result = await speakeasy.apis.deleteApi(
{
apiID: "<value>",
versionID: "<value>",
},
{
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
}
);
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
const speakeasy = new Speakeasy({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
async function run() {
const result = await speakeasy.apis.deleteApi({
apiID: "<value>",
versionID: "<value>",
});
// Handle the result
console.log(result);
}
run();
For supported JavaScript runtimes, please consult RUNTIMES.md.
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
[!TIP]
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
- Node.js v20+: Since v20, Node.js comes with a native
openAsBlobfunction innode:fs.- Bun: The native
Bun.filefunction produces a file handle that can be used for streaming file uploads.- Browsers: All supported browsers return an instance to a
Filewhen reading the value from an<input type="file">element.- Node.js v18: A file stream can be created using the
fileFromhelper fromfetch-blob/from.js.
import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
import { openAsBlob } from "node:fs";
const speakeasy = new Speakeasy();
async function run() {
const result = await speakeasy.schemas.registerSchema({
apiID: "<value>",
versionID: "<value>",
requestBody: {
file: await openAsBlob("./sample-file"),
},
});
// Handle the result
console.log(result);
}
run();
FAQs
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/21dd5d3a-aefc-4cd3-abee-5e17ef1d4dad"> <source media="(
The npm package @speakeasy-api/speakeasy-client-sdk-typescript receives a total of 776 weekly downloads. As such, @speakeasy-api/speakeasy-client-sdk-typescript popularity was classified as not popular.
We found that @speakeasy-api/speakeasy-client-sdk-typescript demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.
Research
/Security News
Socket researchers investigate 4 malicious npm and PyPI packages with 56,000+ downloads that install surveillance malware.
Security News
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.