@optimizely/js-web-sdk
Advanced tools
Comparing version
@@ -555,2 +555,3 @@ 'use strict'; | ||
INVALID_DATAFILE_VERSION: '%s: This version of the JavaScript SDK does not support the given datafile version: %s', | ||
INVALID_VARIATION_KEY: '%s: Provided variation key is in an invalid format.', | ||
}; | ||
@@ -637,3 +638,3 @@ | ||
var NODE_CLIENT_ENGINE = 'node-sdk'; | ||
var NODE_CLIENT_VERSION = '2.3.1'; | ||
var NODE_CLIENT_VERSION = '3.0.0-rc2'; | ||
@@ -640,0 +641,0 @@ /* |
{ | ||
"name": "@optimizely/js-web-sdk", | ||
"version": "2.3.1-beta1", | ||
"version": "3.0.0-beta1", | ||
"description": "Browser wrapper for Optimizely's Javascript SDK", | ||
@@ -28,3 +28,3 @@ "author": "Jordan Garcia <jordan@optimizely.com>", | ||
"dependencies": { | ||
"@optimizely/optimizely-sdk": "2.3.1" | ||
"@optimizely/optimizely-sdk": "3.0.0-rc2" | ||
}, | ||
@@ -31,0 +31,0 @@ "devDependencies": { |
@@ -1,6 +0,6 @@ | ||
# JS SDK Wrapper | ||
# JS Web SDK | ||
### What is it | ||
## What is it | ||
- A backwards compatible wrapper around the JavascriptSDK | ||
- A backwards compatible wrapper around the JavascriptSDK for usage in web browsers | ||
- Provides extendible datafile loading and caching strategies | ||
@@ -11,3 +11,27 @@ - Provides mechanisms for only parts of the page to block rendering until Optimizely is loaded (supplying a maximum timeout) | ||
## Getting Started | ||
### Prerequisites | ||
- Like the JavaScript SDK, this wrapper requires an [ES5-compatible](https://caniuse.com/#feat=es5) environment. | ||
- This wrapper also requires a native ES6 Promise implementation. If your environment does not support Promises, you must set up a [Promise polyfill](https://github.com/stefanpenner/es6-promise). | ||
### Installation | ||
``` | ||
npm install @optimizely/js-web-sdk | ||
``` | ||
### Usage | ||
```js | ||
// ES Modules | ||
import * as optimizelySDK from '@optimizely/js-web-sdk' | ||
// CommonJS | ||
const optimizelySDK = require('@optimizely/js-web-sdk') | ||
``` | ||
```html | ||
<!-- UMD script, assigns to window.jsWebSdk --> | ||
<script src="https://unpkg.com/@optimizely/js-web-sdk/dist/js-web-sdk.browser.umd.min.js"></script> | ||
``` | ||
## Datafile loading / management | ||
@@ -14,0 +38,0 @@ |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
539819
2.52%11083
1.92%165
17.02%+ Added
- Removed