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

pika-id

v1.1.3

Published

The pragmatic ID system

Downloads

1,346

Readme

pika js

Fully typed, 0 dependencies JS implementation of the full Pika specification.

Install

Yarn:

yarn add pika-id

npm:

npm i pika-id

Basic Usage

import Pika from 'pika-id';

// Or in CJS
const {Pika} = require('pika-id');

// Initialize Pika - do this once, then reuse the instance
const pika = new Pika(
	// Define prefix types
	// You can specify either a string or an object per prefix
	// Make sure prefixes are lowercase
	[
		'user',
		{
			prefix: 'ch',
			description: 'Channels',
		},
		{
			prefix: 'sk',
			description: 'Secret key',
			secure: true, // pika secure id
		},
	],
	{
		/**
		 * Optional initialization parameters:
		 * epoch: bigint | number - customize the epoch (millis) that IDs are derived from - by default, this is 1640995200000 (Jan 1 2022)
		 * nodeId: bigint | number - see below
		 * suppressPrefixWarnings: boolean - don't warn on undefined prefixes
		 * disableLowercase: boolean - don't require prefixes to be lowercase
		 **/
	},
);

// Generate a pika id
pika.gen('user');
// => user_Mzc5ODk1NTI4NzgxMTY4NjQ

// Generate a secure id, as registered above
pika.gen('sk');
// => sk_c19iMGI0NTM4ZjU3ZThjYTIyZThjNjNlMTgwOTg5MWMyM18zODA2NTE5MjcwNDc5NDYyNA

Node IDs

By default, Node IDs are calculated by finding the MAC address of the first public network interface device, then calculating the modulo against 1024.

This works well for smaller systems, but if you have a lot of nodes generating Snowflakes, then collision is possible. In this case, you should create an internal singleton service which keeps a rolling count of the assigned node IDs - from 1 to 1023. Then, services that generate Pikas should call this service to get assigned a node ID.

You can then pass in the node ID when initializing Pika like this:

const p = new Pika([], {nodeId: customNodeId});

TypeScript

Pika has strong definitions for TypeScript, including typing all prefix IDs. If you are using TypeScript, you can take advantage of the following utility types.

import Pika, {InferPrefixes, InferId} from 'pika-id';
const pika = new Pika(['nuts', 'bolts']);

// Infer what an ID will look like
type Id = InferIds<typeof pika>;
//   ^? `nuts_${string}` | `bolts_${string}`

// Infer what the prefixes are
type Prefixes = InferPrefixes<typeof pika>;
//   ^? 'nuts' | 'bolts'

Benchmarks

See bench/gen.js for benchmark implementation

The benchmark below was ran on a 2021 MacBook Pro 14" with an m1 Pro chip and 16gb of memory.

Pika#gen x 1,370,869 ops/sec ±0.19% (100 runs sampled)
Snowflake#gen x 2,015,012 ops/sec ±1.88% (97 runs sampled)