@runonatlas/core
is our JavaScript/TypeScript library for Atlas, which provides the base client for direct integration with Atlas services.
This guide is for direct JavaScript/TypeScript integration. If you’re using one of our supported frameworks, we recommend using their dedicated SDKs instead:
These framework-specific SDKs provide better integration and additional features tailored to each framework.
Set the Atlas API key in the environment variables
You can get it from the Atlas Dashboard.
Create the Atlas Client
To initialize the Atlas SDK, you need to instantiate the Atlas Client with your API key:
The Atlas JavaScript client provides several methods to interact with Atlas services:
Register features that your application uses:
The feature registration is used to ensure that the feature is registered in Atlas. If the feature is not registered, it will be registered automatically and an alert will be sent to the administrators.
Check if a customer has access to specific features:
Retrieve all features a customer has access to:
Get detailed information about a customer:
Get information about your pricing model:
When initializing the Atlas client, you can configure a limit callback for a feature. This callback will be called when a limit-based feature is checked. The callback should return the number of usages for the feature.
For example: