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

@bonsai-components/meta-key

v1.2.1

Published

Make meta key less annoying

Downloads

257

Readme

Meta Key

Intro

Meta keys vary based on the platform the user is on. This package aims to make detection and actions (like printing the meta key as a string) easy.

How to install

npm i @bonsai-components/meta-key

How to use

There are 3 different variants:

  • metaKeyInBrowser - handles detection in the browser
  • metaKeyInNodeProcess - handles detection in node
  • metaKey - universal detection (the most code delivered but handles universal usage)

All variants work the same way, (metaKeyMap?: MetaKeyMap<T>) => T. The keys of MetaKeyMap are mac, windows, and other. The values of these fields can be anything; one of the values will be returned depending on the platform detection.

type VoidFunction = () => void;

const alertMetaKeyMap: MetaKeyMap<VoidFunction> = {
  mac: () => console.log('mac'),
  windows: () => console.log('windows'),
  other: () => console.log('other'),
};

const alertConsole: VoidFunction = metaKey<VoidFunction>(alertMetaKeyMap);
alertConsole();

If no MetaKeyMap is provided, the default maps to a string representing meta key symbol:

const metaKeyMapDefault: MetaKeyMap<string> = {
  mac: '⌘',
  windows: '⊞',
  other: '◆',
};

const metaKeyAsString: string = metaKey();

Additionally, if you pass a partial of the MetaKeyMap the missing keys will be filled in with the default. This is handy when wanting to override one string:

const metaKeyAsString: string = metaKey({ windows: 'ctrl +' });

Browser

import { metaKeyInBrowser } from '@bonsai-components/meta-key';

Node Process

import { metaKeyInNodeProcess } from '@bonsai-components/meta-key';

Universal

import { metaKey } from '@bonsai-components/meta-key';