mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00

History

JamesIves b0873d092b 3.4.3 Dependencies		2020-03-31 08:57:48 -04:00
..
dist-node	Dependencies	2020-01-28 00:08:03 -05:00
dist-src	Dependencies	2020-01-28 00:08:03 -05:00
dist-types	Dependencies	2020-01-28 00:08:03 -05:00
dist-web	Dependencies	2020-01-28 00:08:03 -05:00
LICENSE	Dependencies Required	2020-01-28 00:07:56 -05:00
package.json	3.4.3 Dependencies	2020-03-31 08:57:48 -04:00
README.md	Dependencies Required	2020-01-28 00:07:56 -05:00

README.md

deprecation

Log a deprecation message with stack

Usage

Browsers

Browsers	Load `deprecation` directly from cdn.pika.dev `<script type="module"> import { Deprecation } from "https://cdn.pika.dev/deprecation/v2"; </script>`
Node	Install with `npm install deprecation` `const { Deprecation } = require("deprecation"); // or: import { Deprecation } from "deprecation";`

Load deprecation directly from cdn.pika.dev

<script type="module">
  import { Deprecation } from "https://cdn.pika.dev/deprecation/v2";
</script>

Node

Install with npm install deprecation

const { Deprecation } = require("deprecation");
// or: import { Deprecation } from "deprecation";

function foo() {
  bar();
}

function bar() {
  baz();
}

function baz() {
  console.warn(new Deprecation("[my-lib] foo() is deprecated, use bar()"));
}

foo();
// { Deprecation: [my-lib] foo() is deprecated, use bar()
//     at baz (/path/to/file.js:12:15)
//     at bar (/path/to/file.js:8:3)
//     at foo (/path/to/file.js:4:3)

To log a deprecation message only once, you can use the once module.

const Deprecation = require("deprecation");
const once = require("once");

const deprecateFoo = once(console.warn);

function foo() {
  deprecateFoo(new Deprecation("[my-lib] foo() is deprecated, use bar()"));
}

foo();
foo(); // logs nothing

License

ISC