xkcd-wrapper
TypeScript icon, indicating that this package has built-in type declarations

1.3.4 • Public • Published

xkcd.com wrapper

/*
 * Example One
 */
const xkcd = require("xkcd-wrapper");
xkcd.getLatest()
    .then(obj => {
        console.log(xkcd.msg("Latest XKCD post: {link}", obj));
        /*
         * all placeholders that can be used with xkcd.msg()
         *   {link}
         *   {num}
         *   {title}
         *   {safeTitle}
         *   {date}
         *   {alt}
         *   {imgUrl}
         */
    })
    .catch(err => {
        console.log(err);
    });
/*
 * Example Two
 */
const xkcd = require("xkcd-wrapper");
xkcd.getPost(369) // Args: Post number
    .then(obj => {
        console.log("xkcd post 369 is titled " + obj.title);
    })
    .catch(err => {
        console.log(err);
    });
/*
 * Example Three
 */
const xkcd = require("xkcd-wrapper");
xkcd.getRandom()
    .then(obj => {
        console.log(obj.link);
    })
    .catch(err => {
        console.log(err);
    });
/*
 * Example Four
 */
const xkcd = require("xkcd-wrapper");
xkcd.events.on("newPost", (obj) => {
    console.log(JSON.stringify(obj));
});
xkcd.subscribe(3600, "./xkcdWrapperData.json"); // Args: New post check interval in seconds, Data file path

Have any issues, questions or suggestions? Join my Discord server or open a Github issue.

Readme

Keywords

Package Sidebar

Install

npm i xkcd-wrapper

Weekly Downloads

1

Version

1.3.4

License

MIT

Unpacked Size

9.93 kB

Total Files

5

Last publish

Collaborators

  • james-bennett-295