![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
esquire
Advanced tools
Readme
Esquire is a light weight, asynchronous injection framework for JavaScript.
Module definitions are shared, on a per global scope basis; in other words,
the same module is defined only once per window
if running in a browser,
or global
if running under Node.JS
.
Modules are defined by a name
, a list of dependencies, and a constructor
function:
Esquire.define("myModuleName", ['myFirstDependency', 'anotherDependency'], function(first, another) {
// the parameters to the constructor are our dependencies, and in this context
// "this" means the module itself, so "this.name" is "myModuleName"
});
Constructors can return immediately (with a result), or can return a
then-able Promise
which will eventually resolve to the required instance.
Direct injection of a module is supported through the inject(...)
method,
which will return a Promise
to its return value:
new Esquire().inject(['dependencyName'], function(dependency) {
// ... use the dependency here, and either return or throw an exception
}).then(function(result) {
// "result" here will be the value returned by the injected method above
}, function(failure) {
// "failure" here will be the error thrown by the injected method above
});
Modules can also be directly required by the caller, and will be returned
wrapped into a Promise
:
new Esquire().require('requestedModule')
.then(function(result) {
// "result" here will be the instance of the module 'requestedModule'
});
Multiple modules can also be requested simultaneously (both specifying module
names as arguments or an array of string
s):
new Esquire().require('firstModule', 'secondModule')
.then(function(result) {
// result[0] -> instance of 'firstModule'
// result[1] -> instance of 'secondModule'
});
In the examples above, a call to new Esquire()
will create a new injector
and with it, new modules instances are created. Each module instance is only
available to its injector, and never shared across.
On the other hand the global esquire(...)
method will allow to access a per
global scope shared injector.
When calling esquire(...)
with a callback function as its last parameter,
the method will behave like inject(...)
, thus dependencies will be resolved
and passed to callback method, and its return value (if any) will be returned.
esquire(['dependencyName'], function(dependency) {
// ... use the dependency here, and either return or throw an exception
}).then(function(result) {
// "result" here will be the value returned by the injected method above
});
If no callback function was given, the esquire(...)
method will behave like
require(...)
and simply return the required dependencies.
esquire('requestedModule')
.then(function(result) {
// "result" here will be the instance of the module 'requestedModule'
});
As module creation is asynchronous, it might be useful to specify a timeout when creation should fail.
By default the timeout is 2000 ms (2 sec), but a different timeout can be specified at construction time. The minimum timeout is 100 ms.
new Esquire(60000).require('foo')
.then(function(foo) {
// we'll wait up to a minute for "foo" to be created
});
While optional, loading of external scripts is also supported, with the same
Promise
mechanism (especially useful in browser environments).
And as Promise
s can be easily chained, constructs like the following can
be quite useful:
Esquire.load("myOtherScript.js")
.then(function() {
return esquire("moduleFromMyOtherScript");
})
.then(function(myModule) {
// here "myModule" will be the shared global instance of the module
// "moduleFromMyOtherScript" defined in the "myOtherScript.js" file
});
FAQs
Esquire: asynchronous injection framework
We found that esquire 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.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.