Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

tiny-warning

Package Overview
Dependencies
0
Maintainers
1
Versions
7
Issues
File Explorer

Advanced tools

tiny-warning

A tiny warning function

    1.0.3latest

Version published
Maintainers
1
Weekly downloads
7,027,231
decreased by-6.22%

Weekly downloads

Changelog

Source

1.0.3

  • Adding missing license MIT file: #12. tiny-warning was already declared as MIT in the package.json but we have now added the LICENSE file to the project. Thanks @ajkl2533 @Bosch-Eli-Black @matthewtebbs-codaio for pushing this forward
  • Add TS declaration: #13. Thanks @alexanbj!
  • Upgrading to [email protected]

Readme

Source

tiny-warning 🔬⚠️

Build Status npm Downloads per month dependencies min minzip

A tiny warning alternative.

import warning from 'tiny-warning'; warning(truthyValue, 'This should not log a warning'); warning(falsyValue, 'This should log a warning'); // console.warn('Warning: This should log a warning');

API: (condition: mixed, message: string) => void

  • condition is required and can be anything
  • message is an required string that will be passed onto console.warn

Why tiny-warning?

The library: warning supports passing in arguments to the warning function in a sprintf style (condition, format, a, b, c, d, e, f). It has internal logic to execute the sprintf substitutions. tiny-warning has dropped all of the sprintf logic. tiny-warning allows you to pass a single string message. With template literals there is really no need for a custom message formatter to be built into the library. If you need a multi part message you can just do this: warning(condition, 'Hello, ${name} - how are you today?')

Dropping your warning for kb savings!

We recommend using babel-plugin-dev-expression to remove warning calls from your production build. This saves you kb's as well as avoids logging warnings to the console for production.

What it does it turn your code that looks like this:

warning(condition, 'My cool message that takes up a lot of kbs');

Into this

if ('production' !== process.env.NODE_ENV) { warning(condition, 'My cool message that takes up a lot of kbs'); }

Your bundler can then drop the code in the "production" !== process.env.NODE_ENV block for your production builds

Final result:

// nothing to see here! 👍

For rollup use rollup-plugin-replace and set NODE_ENV to production and then rollup will treeshake out the unused code

Webpack instructions

Builds

  • We have a es (EcmaScript module) build (because you know you want to deduplicate this super heavy library)
  • We have a cjs (CommonJS) build
  • We have a umd (Universal module definition) build in case you needed it

We expect process.env.NODE_ENV to be available at module compilation. We cache this value

That's it!

🤘

Keywords

FAQs

What is tiny-warning?

A tiny warning function

Is tiny-warning popular?

The npm package tiny-warning receives a total of 6,651,221 weekly downloads. As such, tiny-warning popularity was classified as popular.

Is tiny-warning well maintained?

We found that tiny-warning demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 09 Jul 2019

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc