npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@godaddy/split-data-loader

v1.1.10

Published

[![Join Slack](https://img.shields.io/badge/Join%20us%20on-Slack-e01563.svg)](https://godaddy-oss-slack.herokuapp.com/)

Downloads

13

Readme

Join Slack

split-javascript-data-loader

Loads serialized rule/segment data from Split.io into the browser local storage.

Installation

Install via npm:

$ npm i @godaddy/split-data-loader --save

Usage

Use this package if you are using Split.io for experimentation on a webpage and want to take advantage of browser caching with localStorage.

Please note that this package is intended to be used in tandem with a split data serializer to create the serializedData parameter properly. An example of such serializer is split-node-serializer.

import loadDataIntoLocalStorage from '@godaddy/split-data-loader'

loadDataIntoLocalStorage({
  serializedData: {
    segmentsData: {
      "segment_1": "{ name: 'segment_1', added: ['test-visitor-1', 'test-visitor-2', 'test-shopper-1'] }",
      "segment_2": "{ name: 'segment_2', added: ['test-visitor-1', 'test-visitor-3', 'test-shopper-2'] }"
    },
    since: '100',
    splitsData: {
      "experiment_1": "{ name: 'experiment_1', status: 'foo' }",
      "experiment_2": "{ name: 'experiment_2', status: 'bar' }"
    },
    usingSegmentsCount: 2
  },
  userId: 'test-visitor-1'
})
// console.log(window.localStorage)
// {
//   "SPLITIO.splits.till": "100",
//   "SPLITIO.split.experiment_1": "{ name: 'experiment_1', status: 'foo' }",
//   "SPLITIO.split.experiment_2": "{ name: 'experiment_2', status: 'bar' }",
//   "SPLITIO.splits.usingSegments": "2",
//   "test-visitor-1.SPLITIO.segment.segment_1": "1",
//   "test-visitor-1.SPLITIO.segment.segment_2": "1"
// }

Function

loadDataIntoLocalStorage

You can use this function to store the following in browser localStorage:

  • Freshness of your data
  • Serialized split data
  • Count of splits using segments
  • Indicators for which segments a userId is a part of

The following option properties are available:

| Property | Description | |-----------------------------------|-------------| | serializedData.segmentsData | An object of segment data you want to use to cache which segments a given userId is part of. (required) | | serializedData.since | The freshness of the incoming serialized data. If this is less than or equal to the since value in localStorage, nothing will happen. (required) | | serializedData.splitsData | An object of serialized split data you want to cache. (required) | | serializedData.usingSegmentsCount | The count of splits using segments. (required) | | userId | The user id that is a part of an experiment. Either a hashed shopperId or visitorGuid. (required) | | storagePrefix | An optional parameter that represents the storage.prefix in the SplitIO configuration of the SplitIO factory you are using. |

Testing

Run the linter:

$ npm run lint

Run unit tests:

$ npm test

Generate a coverage report:

$ npm run coverage

License

MIT