npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

object-wrapper

v1.0.1

Published

Wraps all of an object's functions in a wrapper of your choosing.

Downloads

593

Readme

object-wrapper v1.0.1

Wraps all of an object's functions in a wrapper of your choosing.

API

The object-wrapper package is a single function that returns the wrapped object:

wrapper(object, wrapFcn, objectName, shouldAttachWrappersToObject);

The options to this function are as follows:

  • object: Object | Function: The object (or function) that should be wrapped.
  • wrapFcn: Function: A function invoked each time a wrapped function is run. It receives the following arguments:
    • functionInfo: Object: An object literal with the following fields:
      • namespace: Object: An object representing the namespace of the function, e.g. Dropbox.Client
      • namespaceName: String: A string name for the namespace of the function, e.g. "Dropbox.Client"
      • originalFcn: Function: The original, non-wrapped function, e.g. Dropbox.Client.readFile
      • originalFcnName: String: The original function name, e.g. "readFile";
    • args: Arguments object: The arguments passed to the function.
    • isConstructor: Boolean: True if the function was called with the new keyword, false otherwise.
    • callingFcn: Function: The caller of your wrapping function. Useful if you wish to trim stack traces passing through your wrapper.
  • (Optional) objectName: String: The name for the object, e.g. "Dropbox". Used to construct "namespaceName".
  • (Optional) shouldAttachWrappersToObject: Boolean: Determines if wrapper should return a new object, or place wrappers on the original object. Defaults to false.

The function returns the wrapped object.

Examples

Wrap the assert library to appropriately throw exceptions through the Mocha test runner:

var wrapper = require('object-wrapper').default;
var mocha = require('mocha');
// Permits calling a constructor via fcn.apply.
function construct(constructor, args) {
    function F() : void {
        constructor.apply(this, args);
    }
    F.prototype = constructor.prototype;
    return new F();
}
var wrappedAssert = wrapper(require('assert'), function (funcInfo, args, isConstructor) {
    try {
        if (!isConstructor) {
            return funcInfo.originalFcn.apply(funcInfo.namespace, args);
        } else {
            // Wrapped function called as a constructor. For the assert library, this occurs when
            // new assert.AssertionError objects are constructed.
            return construct(funcInfo.originalFcn, args);
        }
    } catch (e) {
        mocha.throwError(e);
    }
  }
}, 'assert' /* Name to use for root object in fcnInfo objects */);

Limitations

Does not wrap functions on the prototype of the passed-in function. The prototype must be wrapped separately.