Doppler Typescript SDK 1.0.0

A Typescript SDK for Doppler.

• API version: 3
• SDK version: 1.0.0

Table of Contents

• Requirements
• Installation
  • Dependencies
• Authentication
  • Bearer Authentication
• API Endpoint Services
• API Models
• Testing
• Configuration
• Sample Usage
• License

Note

This library is built into Node.js. No additional packages are required. However, it cannot be used in the browser.

Requirements

You should have node and Typescript installed.

Installation

Installing using NPM.

npm install
npm run build

Authentication

To see whether an endpoint needs a specific type of authentication check the endpoint's documentation.

Bearer Authentication

The Doppler API uses bearer tokens as a form of authentication.

The bearer token can be set either for the entire sdk:

const sdk = new Doppler()
sdk.setBearerToken('YOUR_BEARER_TOKEN')

Or per endpoint:

const sdk = new Doppler()
sdk.v3.setBearerToken('YOUR_BEARER_TOKEN')

API Endpoint Services

All URIs are relative to https://api.doppler.com.

Click the service name for a full list of the service methods.

| Service | | :------ | |V3|

API Models

A list documenting all API models for this SDK.

Testing

After you run the install script, you can test your SDK with a simple command.

npm run test

Configuration

Your SDK may require some configuration changes.

This API is configured to use a security token for authorization. You should checkout the sample.js and set your environment settings for process.env.DOPPLER_TOKEN.

Sample Usage

import { Doppler } from './src';


const DOPPLER_BEARER_TOKEN = '';  
const sdk = new Doppler(DOPPLER_BEARER_TOKEN);

(async () => {
  const result = await sdk.V3
    .auditWorkplaceUsersRetrieve();
  console.log(result);
})();
 

Sample usage available inside this directory is sample.js. It's a simple, "hello, world" level program to demonstrate this SDK. Run it with node sample.js.

To see what other functions this SDK is capable of, look inside src/services/*.ts.

By default the SDK will only work with Node.js if you would like to use it in the browser you will need to run npm run bundle this will export the SDK as UDM, ESM and CJS modules into the dist folder.