
Security News
npm ‘is’ Package Hijacked in Expanding Supply Chain Attack
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.
@unkey/api
Advanced tools
@unkey/api `@unkey/api` is a TypeScript client for Unkey. If you prefer a typed experience over calling HTTP endpoints directly, this SDK is for you.
Currently the latest version on npm is v2.0.0-alpha.x, which was released on the main channel by accident. Due to npm’s policy, we can not take it back down.
v2 is coming, but it’s not ready yet and lacks some api methods. Please install @unkey/api@0.35 for now.
npm install @unkey/api@0.35
import { Unkey } from "@unkey/api";
const unkey = new Unkey({ rootKey: "<UNKEY_ROOT_KEY>" });
Important: Always keep your root key safe and reset it if you suspect it has been compromised.
import { verifyKey } from "@unkey/api";
const { result, error } = await verifyKey("key_123");
if (error) {
console.error(error.message);
// Handle potential network or bad request error
// A link to our docs will be in the `error.docs` field
return;
}
if (!result.valid) {
// Do not grant access
return;
}
// Process request
console.log(result);
All methods return either an error
or a result
field, never both and never none. This approach helps with proper error handling.
{
result: T; // The result depends on what method you called
}
{
error: {
message: string;
docs: string; // URL to relevant documentation
}
}
You can customize the base URL for all requests:
const unkey = new Unkey({
rootKey: "<UNKEY_ROOT_KEY>",
baseUrl: "https://my.domain",
});
Configure retry behavior for network errors:
const unkey = new Unkey({
rootKey: "<UNKEY_ROOT_KEY>",
retry: {
attempts: 3,
backoff: (retryCount) => retryCount * 1000,
},
});
To opt out of anonymous telemetry data collection:
const unkey = new Unkey({
rootKey: "<UNKEY_ROOT_KEY>",
disableTelemetry: true,
});
FAQs
@unkey/api `@unkey/api` is a TypeScript client for Unkey. If you prefer a typed experience over calling HTTP endpoints directly, this SDK is for you.
We found that @unkey/api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 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.
Security News
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.
Security News
A critical flaw in the popular npm form-data package could allow HTTP parameter pollution, affecting millions of projects until patched versions are adopted.
Security News
Bun 1.2.19 introduces isolated installs for smoother monorepo workflows, along with performance boosts, new tooling, and key compatibility fixes.