lazy-api

A minimalist module for loading API resources when they are used.

Philosophy

Having a big service API wrapper written in NodeJS, most of people create a for loop and load all API files before doing anything. The files are loaded in RAM. So, It's not so RAM friendly to load them this way.

With the lazy-api module this issue is fixed. Lazy API loads the file when the API method is called. If an application only uses one file, only that file will be loaded in RAM. The other will not be loaded.

:cloud: Installation

# Using npm
npm install --save lazy-api

# Using yarn
yarn add lazy-api

:clipboard: Example

// Dependencies
var LazyApi = require("lazy-api");

var Apis = {};

// Instead of doing
// Apis.some = require("./some");
// we do:
LazyApi(Apis, "some", __dirname + "/some");

// And when we will call this method, the file
// will be loaded in the RAM.
Apis.some.method({foo: "bar"}, function (err, d) {
    console.log(err || d);
});

// What if we need to run some custom handlers?
LazyApi.returnHandler = function (path, name, scope) {
    console.log("Loading " + path);
    return require(path);
};

// "Load" (but not in RAM) the another file
LazyApi(Apis, "another", __dirname + "/another");

// Call the method (this will load the file)
Apis.another.method({foo: "bar"}, function (err, d) {
    console.log(err || d);
});

// Call the method again (the file is already loaded);
Apis.another.method({foo: "bar"}, function (err, d) {
    console.log(err || d);
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

LazyApi(scope, name, path)

Defines the new property in the scope, adding the get handler.

Params

• Object scope: The scope object (default: this)
• String name: Property (API) name
• String path: The path to JavaScript/JSON file.

Return

• Object The object where the property was defined.

returnHandler(path, name, scope)

The default function that will be called when a property is accessed. This function can be overrided with custom code.

Params

• String path: The path to JavaScript/JSON file.
• String name: Property (API) name
• Object scope: The scope object (default: this)

Return

• Object The export object of a JSON/JavaScript file.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• brightbox

:scroll: License

MIT © Ionică Bizău