Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

exist-utils

Package Overview
Dependencies
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

exist-utils

Utility functions that emulate CoffeeScript existence operator

  • 1.0.5
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
7
decreased by-46.15%
Maintainers
1
Weekly downloads
 
Created
Source

exist-utils NPM Version Build Status Coverage Status dependencies Status devDependencies Status

This package is a collection of util functions that emulate CoffeeScript existence operator. While waiting that some of them are integrated in the next version of JavaScript, you can use this package while porting from CoffeeScript, etc.

Installation

Node Installation

npm install exist-utils

You can then ExistUtils = require('exist-utils') or import * as ExistUtils from 'exist-utils'.

Browser Installation

Use the minified UMD build in the dist folder: here. It exports a global window.ExistUtils when imported as a <script> tag.

Usage

Each function as a full name (i.e. exists) and a shorthand (i.e. ex), both are specified in the title of their description. You can check the equivalence with CoffeeScript operators in the following section.

exists (ex)

Example:

if (!exists(arg)) {
  error('missing arg');
}

This is the equivalent to CoffeeScript val?, it checks if a value "exists" (is neither null nor undefined).

existsChained (exc)

Example:

if (!existsChained(arg, 'callback')) {
  error('no callback specified');
}

This is the equivalent to CoffeeScript obj?.prop?, it checks if a whole chain "exists".

existsChainedValue (excv)

Example:

const callback = existsChainedValue(arg, 'callback');
if (!exists(callback)) {
  error('no callback specified');
  return;
}
callback();

This is the equivalent to CoffeeScript obj?.prop, it checks if a whole chain "exists" and returns the final value.

elvis (el)

Example:

val = elvis(arg, 42);

This is the equivalent to CoffeeScript val ? default and a safer version to val || default. It returns the second value if the first one doesn't "exist".

callsIfExist (fnex)

Example:

callsIfExist(func, 1, 2);

This is the equivalent to CoffeeScript func?(1, 2), it checks the existence of the function and calls it with the provided arguments.

callsIfExistObj (fnexo)

Example:

callsIfExistObj(obj, 'func', 1, 2);

This is the equivalent to CoffeeScript obj?.func?(1, 2), it checks the existence of the function and calls it with the provided arguments while providing the right value for this.

CoffeeScript equivalents

CoffeeScriptexist-utilsexist-utils shorthand
val?exists(val)ex(val)
obj?.prop?existsChained(obj, 'prop')exc(obj, 'prop')
obj?.propexistsChainedValue(obj, 'prop')excv(obj, 'prop')
val = arg ? 3val = elvis(arg, 3)val = el(arg, 3)
func?(a, b)callsIfExist(func, a, b)fnex(func, a, b)
obj.func?(a, b)callsIfExistObj(obj, func, a, b)fnexo(obj, func, a, b)

License

MIT, Copyright (c) 2017-2020 Louis Brunner

Keywords

FAQs

Package last updated on 31 Aug 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc