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

stream-schema-detector

v2.1.0

Published

detect of schema of event streams

Downloads

5

Readme

stream-schema-detector

Detect schema of event streams.

detectSchema(object)

Can detect the schema of a single object:

const { detectSchema } = require('./main');

const schema = detectSchema({ a: 23, b: { c: true, d: [12, true] } });

// schema is:
{
  'a': ['number'],
  'b': ['object'],
  'b.c': ['boolean'],
  'b.d': ['array'],
  'b.d[]': ['number']
}

createStreamSchemaDetector({ loadSchema, saveSchema, maxCacheSize })

Creates a detect function which will detect the schema of multiple events by type and update them when detected schema differs from stored version.

  • loadSchema(typeParam):

    called when no cached schema is found for given typeParam, should return a saved schema. typeParam could be any json strigifiable value.

  • saveSchema(typeParam, schema, exampleItem):

    called when the detected schema differs from one returned by loadSchema.

  • maxCacheSize

    the number of schemas to cache in memory (default is 500)

  • detect(typeParam, item):

    the returned function, can be called with a typeParam and an item we want to inspect.

    Will call loadSchema for the given typeParam and compare its return value with the detected schema of the item. Calls saveSchema if detected schema differs from saved one.

    The result of loadSchema is cached in memory, it will only be called once for each typeParam until no differences are detected.

const { createStreamSchemaDetector } = require('./main');

const schemaStore = {};
const loadSchema = async typeId => schemaStore[typeId];
const saveSchema = async (typeId, schema) => {
  schemaStore[typeId] = schema;
};

const detect = createStreamSchemaDetector({ loadSchema, saveSchema });

await detect('browse_events', { a: 4, b: 'hat' });
await detect('browse_events', { a: 23, b: true, c: 14 });
await detect('purchase', { x: 2 });

// content of schemaStore:
{
  'browse_events': { a: ['number'], b: ['string', 'boolean'], c: ['number'] },
  'purchase': { x: ['number'] }
}

Using object as typeParam

const schemaStore = {};
const loadSchema = async ({ source, type }) => schemaStore[`${source}_${type}`];
const saveSchema = async ({ source, type }, schema) => {
  schemaStore[`${source}_${type}`] = schema;
};

const detect = createStreamSchemaDetector({ loadSchema, saveSchema });

await detect({ source: 'A', type: 'x' }, { a: 4});

// schemaStore:
{ 'A_x': { a: ['number'] } }