https://github.com/conejerock/nuxt-unleash
Nuxt.js module to use Unleash toggle feature services
https://github.com/conejerock/nuxt-unleash
Last synced: about 1 year ago
JSON representation
Nuxt.js module to use Unleash toggle feature services
- Host: GitHub
- URL: https://github.com/conejerock/nuxt-unleash
- Owner: conejerock
- License: mit
- Created: 2022-03-14T17:03:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-17T10:21:42.000Z (over 2 years ago)
- Last Synced: 2025-04-17T04:19:23.763Z (about 1 year ago)
- Language: TypeScript
- Size: 971 KB
- Stars: 20
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
)
# nuxt-unleash
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]
> Nuxt.js module to use [Unleash](https://github.com/Unleash/unleash) toggle feature services
[📖 **Release Notes**](./CHANGELOG.md)
## Features
Use `$unleash` to access and handle your *Unleash* feature flags in client side,
or `context.app.unleash` to access _Unleash_ feature flags from server side.
## Setup
1. Add `nuxt-unleash` dependency to your project
```bash
yarn add nuxt-unleash
```
2. Add `nuxt-unleash` to the `modules` section of `nuxt.config.js`
```js
export default {
modules: [
// Simple usage
'nuxt-unleash',
// With options
['nuxt-unleash', { /* module options */ }]
]
}
```
:warning: If you are using Nuxt **< v2.9** you have to install the module as a `dependency` (No `--dev` or `--save-dev` flags) and use `modules` section in `nuxt.config.js` instead of `buildModules`.
### Using top level options
```js
export default {
buildModules: [
'nuxt-unleash'
],
unleash: {
/* module options */
}
}
```
## Options
### `url`
- Type: `String`
- Required: `true`
Unleash API URL
### `instanceId`
- Type: `String`
- Required: `true`
Unleash API Instance ID
### `environment`
- Type: `String`
- Required: `false`
Name of the environment your Unleash application runs in. If is not filled in, the response will be an empty array. See the [example configuration](https://docs.gitlab.com/ee/operations/feature_flags.html#golang-application-example).
### `config`
The module allows some configuration parameters.
If you want to default to the value of a feature that doesn't exist, use:
`enabledDefault: true`
On the other hand, to set a header as the source of the ip, you can add:
`headerIP: 'CF-Connection-IP'`
## Usage
#### Client Side
To access the module in __side client__ you just have to call `this.$unleash` and method you want to use.
```js
{{ value ? 'enabled' : 'disabled' }}
export default {
mounted() {
this.value = this.$unleash.isEnabled('new-feature')
}
}
```
#### Sever Side
To access the module in __side server__ you just have to call `ctx.app.unleash` and method you want to use.
```js
asyncData(ctx) {
const value = ctx.app.unleash.isEnabled('new-feature')
if(value) {
ctx.redirect('/new-feature-page')
}
}
```
### Methods
The library provides four methods:
#### exists
Returns whether a feature flag exists
```js
this.$unleash.exists('new-feature')
```
#### isEnabled
If the feature flag exists, return its status value. Otherwise, return the value of module option `enabledDefault`.
```js
this.$unleash.isEnabled('new-feature')
```
#### isAllowUser
If feature flag has the strategy `userWithId` as user list (comma separated), returns whether *myUsername* is in the user list of `userIds`.
```js
this.$unleash.isAllowUser('new-feature', 'myUsername')
```
#### isAllowIP
If feature flag has the strategy `userWithId` as IP list (comma separated), returns whether the current request IP is in the IP list of `userIds`.
```js
this.$unleash.isAllowIP('new-feature')
```
*Pd: It's necessary to activate **vuex** for this functionality*
## Development
1. Clone this repository
2. Install dependencies using `yarn install` or `npm install`
3. Start development server using `npm run dev`
## License
[MIT License](./LICENSE)
Copyright (c) Conejerock
[npm-version-src]: https://img.shields.io/npm/v/nuxt-unleash/latest.svg
[npm-version-href]: https://npmjs.com/package/nuxt-unleash
[npm-downloads-src]: https://img.shields.io/npm/dt/nuxt-unleash.svg
[npm-downloads-href]: https://npmjs.com/package/nuxt-unleash
[github-actions-ci-src]: https://github.com/conejerock/nuxt-unleash/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/conejerock/nuxt-unleash/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/conejerock/nuxt-unleash.svg
[codecov-href]: https://codecov.io/gh/conejerock/nuxt-unleash
[license-src]: https://img.shields.io/npm/l/nuxt-unleash.svg
[license-href]: https://npmjs.com/package/nuxt-unleash