Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

cyclon.p2p-common

nicktindall55MIT0.1.11TypeScript support: included

Common utilities used by the cyclon.p2p stuff

cyclon.p2p, utils

readme

cyclon.p2p-common

Build Status Dependencies

Some utilities used by various cyclon.p2p modules

Usage

First install cyclon.p2p-common as a runtime dependency

npm install cyclon.p2p-common --save

Then include the library using require

var cyclonUtils = require('cyclon.p2p-common');

The API

randomSample(inputArray, sampleSize)

Select a random sample of items from an array using reservoir sampling.

Parameters

  • inputArray The array to sample from.
  • sampleSize The number of items to sample.

checkArguments(argumentsArray, expectedCount)

Check that an arguments array contains the expected number of items, throw an Error otherwise.

Parameters

  • argumentsArray The arguments array to check.
  • expectedCount The expected size of the arguments array.

consoleLogger()

Get the singleton ConsoleLogger instance.

newInMemoryStorage()

Create instances of an in-memory implementation of the DOM storage API.

asyncExecService()

Get the singleton instance of the AsyncExecService interface that's used in a lot of places.

obfuscateStorage(storage)

Decorate implementations of the DOM storage API with an obfuscating layer

Parameters

  • storage The storage to obfuscate.

shuffleArray(inputArray)

Shuffle an array in place.

Parameters

  • inputArray The array to shuffle.