@toggles/experiments

Create, update, and delete experiments and determine if they are active for users/audiences.

Install

Install with npm.

``sh
$ npm i @toggles/experiments
`

Usage

`js
const toggles = require('@toggles/experiments');
const client = toggles({
apiKey: 'KEY',
})

async function main() {
const {uuid} = await toggles.createExperiment({name: 'foo'})

await toggles.updateExperiment(uuid, {name: 'bar', percent: 100})

const experiments = await toggles.getExperiments()
const experiment = await toggles.getExperimentById(uuid)

const active = await toggles.isExperimentActive(uuid, {uniqueId: 'foo@bar.co'})
}
`

Client Methods

$3

`js
const options = {
apiKey: 'string', // This comes from the Settings tab of the Dashboard.
}
const client = toggles.createClient(options)
`

$3

`js
const params = {
name: 'string',
}

const experiment = await client.createExperiment(params)

console.log(experiment)

// {
// description: 'string',
// enabled: boolean,
// name: 'string',
// percent: number,
// uuid: 'string',
// }
`

$3

`js
const success = await client.createExperiment(experiment.uuid)

console.log(success) // boolean
`

$3

`js
const key = client.getAPIKey()
`

$3

`js
const url = client.getAPIUrl()
`

$3

`js
const experiment = await client.getExperiment(experiment.uuid)

console.log(experiment)

// {
// description: 'string',
// enabled: boolean,
// name: 'string',
// percent: number,
// uuid: 'string',
// }
`

$3

`js
const experiments = await client.getExperiments()

console.log(experiment)

// [
// {
// description: 'string',
// enabled: boolean,
// name: 'string',
// percent: number,
// uuid: 'string',
// },
// ]
`

$3

`js
const experiment = client.getLocalExperiment(experiment.uuid)

console.log(experiment)

// {
// description: 'string',
// enabled: boolean,
// name: 'string',
// percent: number,
// uuid: 'string',
// }
`

$3

`js
const params = {
uniqueId: 'string', // optional
}

const active = await client.isExperimentActive(experiment.uuid, params)

console.log(active) // boolean
`

$3

`js
client.setAPIKey('KEY')
`

$3

`js
const params = {
description: 'string',
enabled: true,
name: 'string',
percent: 100,
}

const experiment = await client.updateExperiment(experiment.uuid, params)

console.log(experiment)

// {
// description: 'string',
// enabled: boolean,
// name: 'string',
// percent: number,
// uuid: 'string',
// }
``

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

License

Copyright © 2019 []
Licensed under the MIT license.

*

_This file was generated by readme-generator on June 21, 2019._