\n\nFaster is a framework which provides analytics and remote-config features.\nThis project is related to SDK for Javascript development given a easy-to-use API to work with.\n\nCurrently released features:\n\n- Analytics ([Check Package](https://www.npmjs.com/package/faster-sdk-js)):\n\n - Track Device Installation\n - Session Control\n - Track & Send Events\n\n- Remote Config (This package):\n\n - Run AB Tests\n - Manage Feature Rollout\n - Manage Feature Flags\n\n## 1 - Getting Started\n\n### Installing\n\nGet the package from the public npm registry, with your favorite package manager:\n\n```bash\nyarn add faster-remote-config-sdk-js\n```\n\nor\n\n```bash\nnpm install faster-remote-config-sdk-js\n```\n\n### Requirements\n\n#### Faster Analytics\n\nFaster Remote Config has Faster Analytics as a dependency. To install and set up Faster Analytics\ncheck the [documentation](https://www.npmjs.com/package/faster-sdk-js).\n\n#### Create Remote Configs\n\nRemote Configs, Feature Flags and AB Tests are created on [Faster Admin system](https://admin.fstr.rocks/).\nPlease, contact the faster-team at Movile for more information.\n\n### Usage\n\nImport the Faster Remote Config module and FasterConfiguration object using ES6 syntax.\n\n```javascript\nimport RemoteConfig, { RemoteConfigConfiguration } from 'faster-remote-config-sdk-js';\n```\n\n### Configuring & Running\n\nNow, configure and start Faster Remote Config SDK:\n\n```javascript\nconst fasterConfigurationOptions = { appVersion: '__appVersion__' };\nconst configuration = new RemoteConfigConfiguration('__appKey__', fasterConfigurationOptions);\nRemoteConfig.configure(configuration);\nconst fstr = RemoteConfig.start(analyticsInstance);\n```\n\n## 2 - API Reference\n\n#### **FasterConfiguration.constructor(applicationKey, appVersion, options)**\n\n- **applicationKey**: The application key created for your application in the Faster Admin system.\n Use the same key used for Faster Analytics.\n- **options**: Optional parameters to configure the Faster modules:\n - **appVersion**: Your application version string, used for tracking.\n\n#### **Faster.configure(configuration)**:\n\n- **configuration** : FasterConfiguration instance.\n\n#### **Faster.start(analyticsInstance)**:\n\nStartup faster remote config\n\n- **analyticsInstance**: Faster Analytics instance of type FasterAnalytics. Check the [documentation](https://www.npmjs.com/package/faster-sdk-js).\n\n#### **Faster.get(config, custom, latitude?, longitude?)**:\n\nRetrieve a remote config value.\n\n- **config**: Configuration Object generated by [Faster CLI](https://github.com/Movile/faster-cli/).\n- **custom**: Custom object of key and values that may be useful for a remote config.\n Necessary to provide when getting a remote configs with `context` rule/segmentation.\n- **latitude**: Optional device latitude. Necessary to provide when getting a remote configs with `polygon` rule/segmentation.\n- **longitude**: Optional device longitude. Necessary to provide when getting a remote configs with `polygon` rule/segmentation.\n\n###### Javascript\n\n```javascript\nconst value = await fasterRemoteConfig.get(fasterConfig, { plus: true }, '-22.8829362', '-47.0678489');\n```\n\n###### Typescript\n\n```typescript\ntype RemoteConfigSchema = {\n enabled: boolean;\n version: 'v0' | 'v1';\n};\nconst value = await fasterRemoteConfig.get(\n fasterNonStickyConfig,\n { plus: true },\n '-22.8829362',\n '-47.0678489'\n);\n```\n\n#### **Faster.getForced(config, custom, latitude?, longitude?)**:\n\nSame as the get() but this doesn't use the cache from the SDK JS and will always get the value from the server when using this API. Only works for non-sticky remote config.\n\n- **config**: Configuration Object generated by [Faster CLI](https://github.com/Movile/faster-cli/).\n- **custom**: Custom object of key and values that may be useful for a remote config.\n Necessary to provide when getting a remote configs with `context` rule/segmentation.\n- **latitude**: Optional device latitude. Necessary to provide when getting a remote configs with `polygon` rule/segmentation.\n- **longitude**: Optional device longitude. Necessary to provide when getting a remote configs with `polygon` rule/segmentation.\n\n##### Example:\n\n###### Javascript\n\n```javascript\nconst value = await fasterRemoteConfig.getForced(fasterNonStickyConfig, { plus: true }, '-22.8829362', '-47.0678489');\n```\n\n###### Typescript\n\n```typescript\ntype RemoteConfigSchema = {\n enabled: boolean;\n version: 'v0' | 'v1';\n};\n\nconst value = await fasterRemoteConfig.getForced(\n fasterNonStickyConfig,\n { plus: true },\n '-22.8829362',\n '-47.0678489'\n);\n```\n\n## 3 - Faster CLI\n\nFaster remote config has a fallback system to avoid let the user without any value. This system consists in create a local object\nin our app with the remote config default value. To generate this object you can use Faster CLI.\n\n### Install\n\n```\npip3 install http://s3.amazonaws.com/faster-dropbox/faster-cli/faster-cli-py3-none-any.whl\n```\n\n### Generate Faster Config\n\n```\nfaster remote-config generate-defaults -p product -c configName -l javascript --path ${pwd}/example/\n```\n\nPlease, check out the [documentation](https://github.com/Movile/faster-cli/) or contact the faster-team at Movile for more information.\n","readmeFilename":"README.md","homepage":"https://github.com/faster/faster-sdk-js#readme","bugs":{"url":"https://github.com/faster/faster-sdk-js/issues"}}
![\"Faster\"](\"https://faster-dropbox.s3.amazonaws.com/assets/faster-logo.png\"){kind=logo}
\n