{"_id":"leverage","_rev":"28-af0c32720ae76a32b438ce669845a8a6","name":"leverage","description":"Leverage is a thin wrapper around the `redis` client that integrates your lua scripts as methods AND supports reliable and fault tolerant Pub/Sub on top of redis.","dist-tags":{"latest":"0.1.3"},"versions":{"0.0.0":{"name":"leverage","version":"0.0.0","description":"Leverage the awesome power of lua scripting through redis","main":"index.js","scripts":{"test":"NODE_ENV=testing ./node_modules/.bin/mocha $(find test -name '*.test.js')"},"repository":"","keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"~1.6.0","mocha":"~1.9.0","redis":"~0.8.3","pre-commit":"~0.0.3"},"dependencies":{"underverse":"0.0.0"},"_id":"leverage@0.0.0","dist":{"shasum":"7db0de17998f9ad1e40cb3ac0fef41a1dde37faf","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.0.0.tgz","integrity":"sha512-CKj1rxN9K6Ecj9+31rC0LQbC8zQe7DaawwK3hl+0NURQaP2XHCNrNdV55RX2FNYtKs3nFdFwZijPxtGqaqH3GQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDiVLlp+wi6NxZjAF1CirvL8QEYJHbUkGIZQI2zeDIS7gIhAO20L5TmWmhGfwTVRUoGNsxE114KBzmTy3R7YQ2vCEfC"}]},"_npmVersion":"1.1.71","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.1":{"name":"leverage","version":"0.0.1","description":"Leverage the awesome power of lua scripting through redis","main":"index.js","scripts":{"test":"NODE_ENV=testing ./node_modules/.bin/mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"1.6.x","mocha":"1.9.x","redis":"0.8.x","pre-commit":"0.0.x"},"dependencies":{"underverse":"0.0.x"},"_id":"leverage@0.0.1","dist":{"shasum":"c5f140dd71559a5051e6e5500e9b84f8c318d0b4","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.0.1.tgz","integrity":"sha512-LYfIxTr9dQJA45IgvjiyRZkMm40ccUZVo4YRsJaSC9IOL5rXJ7nyEVkdtl1gEVK/GuLrWL3OBW8VW7WhSg+FrA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDk0XZtmapRzlFSZ7ASEXTJ84yveHrzrvYGCc50JeXdowIgaKe1nR9sbowEkGMD3OJ/Q2kJTbx0hFBVMaZTnIGiZlo="}]},"_npmVersion":"1.1.71","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.2":{"name":"leverage","version":"0.0.2","description":"Leverage the awesome power of lua scripting through redis","main":"index.js","scripts":{"test":"NODE_ENV=testing ./node_modules/.bin/mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"1.6.x","mocha":"1.9.x","redis":"0.8.x","pre-commit":"0.0.x"},"dependencies":{"underverse":"0.1.x"},"_id":"leverage@0.0.2","dist":{"shasum":"a55de0949a5e314af05a7efc7067ce94f98e56e6","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.0.2.tgz","integrity":"sha512-9L6YbuZbF2VQL/rjIbMt/deO/bedS+rQazumEZ7QrxeLJG3klj6US+HcNYAaMJzlgLvwMJZwFL2bjUigbvnBNg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF0KdqRvWqqNUpTBSjZHw66lPVzK1HmcAYwpTIPNzTl7AiEA4PMKj4mhHMeDe60rV/HN2rXG9AKhWW4PKo5uI6IU7+Y="}]},"_from":".","_npmVersion":"1.2.14","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.3":{"name":"leverage","version":"0.0.3","description":"Leverage is a thin wrapper around the `redis` client that integrates your lua scripts as methods AND supports reliable and fault tolerant Pub/Sub on top of redis.","main":"index.js","scripts":{"test":"NODE_ENV=testing ./node_modules/.bin/mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"1.6.x","mocha":"1.9.x","redis":"0.8.x","pre-commit":"0.0.x"},"dependencies":{"underverse":"0.1.x"},"_id":"leverage@0.0.3","dist":{"shasum":"ad1df19dacc9bfbb10e60745342bf601c7109f03","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.0.3.tgz","integrity":"sha512-kU03vb5pOwNMwmCVq+PJTE5w1hxrVCz9UzvR+I8eH6ycuIUgv7rP3y8HUK3WuhXXq8vTVkjlrmRs8d0LbXR1wA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFu6H/84ykweXz9n3J4c62n9+uX3dl/pONeTm19AzarEAiB3TP8INwTBUPdpQ1Z5LLIbf1fTqjEV7bNhaJwmRxU+AA=="}]},"_from":".","_npmVersion":"1.2.14","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.4":{"name":"leverage","version":"0.0.4","description":"Leverage is a thin wrapper around the `redis` client that integrates your lua scripts as methods AND supports reliable and fault tolerant Pub/Sub on top of redis.","main":"index.js","scripts":{"test":"NODE_ENV=testing ./node_modules/.bin/mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"1.6.x","mocha":"1.9.x","redis":"0.8.x","pre-commit":"0.0.x"},"dependencies":{"underverse":"0.1.x"},"bugs":{"url":"https://github.com/observing/leverage/issues"},"_id":"leverage@0.0.4","dist":{"shasum":"b0b195947ef457a49eeef58bd3370c7fe0b28ddd","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.0.4.tgz","integrity":"sha512-ikPF9XHdkA+p/uHvE5aQ/QpQetF68BmeVD8z4IDR+IDL9oCQsMw8PPPbo90q5TPtmYE5vHSoMKbt+aAaGRXXTg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCH7O/uIUyFYwV7//+9dUX06DPfkV6uNCL2qDQ/UNfcnwIgEEc26TnOZPQ9ttAq8MNAqQcPKK3bnN30TvvY/Gyua1A="}]},"_from":".","_npmVersion":"1.3.5","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}]},"0.0.5":{"name":"leverage","version":"0.0.5","description":"Leverage is a thin wrapper around the `redis` client that integrates your lua scripts as methods AND supports reliable and fault tolerant Pub/Sub on top of redis.","main":"index.js","scripts":{"test":"NODE_ENV=testing ./node_modules/.bin/mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"1.6.x","mocha":"1.9.x","redis":"0.8.x","pre-commit":"0.0.x"},"dependencies":{"underverse":"0.1.x"},"bugs":{"url":"https://github.com/observing/leverage/issues"},"homepage":"https://github.com/observing/leverage","_id":"leverage@0.0.5","_shasum":"caffead25ae21593eaa7bbba350eed58b9e77b59","_from":".","_npmVersion":"1.4.10","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}],"dist":{"shasum":"caffead25ae21593eaa7bbba350eed58b9e77b59","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.0.5.tgz","integrity":"sha512-NonGtgYrRUkR87RaPMIIuzPmeY52Q0cBxPx57qNIIps5wbRzhWYUGL0UFB+4jYX2QyOXVeUKjQ+Pj1RkWkNvOA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE9Wqm7DIv4ewqJCdNmxmtxlMqHf3pUi0vSSFb0sYzfFAiAShfQEW7daYIYvei3spGax7lUBnZSFcujuemssGqtinQ=="}]}},"0.1.0":{"name":"leverage","version":"0.1.0","description":"Leverage is a thin wrapper around the `redis` client that integrates your lua scripts as methods AND supports reliable and fault tolerant Pub/Sub on top of redis.","main":"index.js","scripts":{"test":"mocha $(find test -name '*.test.js') --ui bdd --reporter spec","coverage":"istanbul cover ./node_modules/.bin/_mocha -- test/*.test.js --reporter spec --ui bdd test.js"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"1.9.x","istanbul":"0.3.x","mocha":"2.0.x","pre-commit":"0.0.x","redis":"0.12.x"},"dependencies":{"diagnostics":"0.0.x","eventemitter3":"0.1.x","fusing":"0.4.0","underverse":"0.1.x"},"gitHead":"48afbb939ee0f250045869145c1546dbfcffd7f0","bugs":{"url":"https://github.com/observing/leverage/issues"},"homepage":"https://github.com/observing/leverage","_id":"leverage@0.1.0","_shasum":"30bceac5070359a1a622156a800b314c4f25cc32","_from":".","_npmVersion":"1.4.28","_npmUser":{"name":"V1","email":"info@3rd-Eden.com"},"maintainers":[{"name":"V1","email":"info@3rd-Eden.com"}],"dist":{"shasum":"30bceac5070359a1a622156a800b314c4f25cc32","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.1.0.tgz","integrity":"sha512-/xYXXvzr1OD4DfU8RbjsCKVXKyyVcVzLH7p3v8icdke1KiOVDqyq5yPq5YZDUrnvlmB8XbUuKPCPweHrI6s6Mw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA0iTBxKhQTDIW33gqSiEohC+NytjQkOHW9JJFxhFX7cAiAexSkAOQqbxzZESwweCPLqr00JqzTEJJiSdz0zqdUlfA=="}]}},"0.1.1":{"name":"leverage","version":"0.1.1","description":"Leverage is a thin wrapper around the `redis` client that integrates your lua scripts as methods AND supports reliable and fault tolerant Pub/Sub on top of redis.","main":"index.js","scripts":{"test-travis":"istanbul cover node_modules/.bin/_mocha --report lcovonly -- test/*.test.js","coverage":"istanbul cover ./node_modules/.bin/_mocha -- test/*.test.js","test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"2.1.x","istanbul":"0.3.x","mocha":"2.2.x","pre-commit":"1.0.x","redis":"0.12.x"},"dependencies":{"diagnostics":"0.0.x","eventemitter3":"0.1.x","fusing":"1.0.x","underverse":"0.1.x"},"gitHead":"6278d7cbc3e4172aa18e7522baa5f44a7f92df0c","bugs":{"url":"https://github.com/observing/leverage/issues"},"homepage":"https://github.com/observing/leverage","_id":"leverage@0.1.1","_shasum":"02d7dc510516a94fccd5f1c92dfa7cf6e204e5fb","_from":".","_npmVersion":"2.3.0","_nodeVersion":"0.10.35","_npmUser":{"name":"3rdeden","email":"npm@3rd-Eden.com"},"maintainers":[{"name":"v1","email":"info@3rd-Eden.com"},{"name":"3rdeden","email":"npm@3rd-Eden.com"}],"dist":{"shasum":"02d7dc510516a94fccd5f1c92dfa7cf6e204e5fb","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.1.1.tgz","integrity":"sha512-IRiYj5khAZEYMYPTCwMZVmfcFdydj3NNJoRhQGcRykJDlt+HIgacgzLxUkspZgmVqcGer3H9UbQiNUYolaXwNA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIArFvoRPHBdG1SpzUzce+QgiZ4zJxNLMv9MOeLTO1GIXAiA003fXM+1rhYQJkg0X6ed5Cn2HjGX3PvkgZ67HTgzT9A=="}]}},"0.1.2":{"name":"leverage","version":"0.1.2","description":"Leverage is a thin wrapper around the `redis` client that integrates your lua scripts as methods AND supports reliable and fault tolerant Pub/Sub on top of redis.","main":"index.js","scripts":{"test-travis":"istanbul cover node_modules/.bin/_mocha --report lcovonly -- test/*.test.js","coverage":"istanbul cover ./node_modules/.bin/_mocha -- test/*.test.js","test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"2.1.x","istanbul":"0.3.x","mocha":"2.2.x","pre-commit":"1.0.x","redis":"0.12.x"},"dependencies":{"diagnostics":"0.0.x","eventemitter3":"0.1.x","fusing":"1.0.x","underverse":"0.1.x"},"gitHead":"e1b19a471fc1857c7660df4e02b92806b7d14c2d","bugs":{"url":"https://github.com/observing/leverage/issues"},"homepage":"https://github.com/observing/leverage","_id":"leverage@0.1.2","_shasum":"89715f2d6e98aaa61a426859632bef2810604a16","_from":".","_npmVersion":"2.3.0","_nodeVersion":"0.10.35","_npmUser":{"name":"3rdeden","email":"npm@3rd-Eden.com"},"maintainers":[{"name":"v1","email":"info@3rd-Eden.com"},{"name":"3rdeden","email":"npm@3rd-Eden.com"}],"dist":{"shasum":"89715f2d6e98aaa61a426859632bef2810604a16","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.1.2.tgz","integrity":"sha512-XfYkxwnCD1lXBlRfEhX1KIqGUb4AEc6WD2LyZ2M3mTzUBd3syitIMg3MAVYF2T2jtsw2fgTaoEwzTA6EpQtnbA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBN91du/Se2QaNabf8R7OyChjINWN2J4IoU+8fpkumG4AiASdt1fV9agCve4IiOlP+z6DBhWQ0UlA+Y+7wIYbeO/JA=="}]}},"0.1.3":{"name":"leverage","version":"0.1.3","description":"Leverage is a thin wrapper around the `redis` client that integrates your lua scripts as methods AND supports reliable and fault tolerant Pub/Sub on top of redis.","main":"index.js","scripts":{"test-travis":"istanbul cover node_modules/.bin/_mocha --report lcovonly -- test/*.test.js","coverage":"istanbul cover ./node_modules/.bin/_mocha -- test/*.test.js","test":"mocha $(find test -name '*.test.js')"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"license":"MIT","devDependencies":{"chai":"2.1.x","istanbul":"0.3.x","mocha":"2.2.x","pre-commit":"1.0.x","redis":"0.12.x"},"dependencies":{"diagnostics":"0.0.x","eventemitter3":"0.1.x","fusing":"1.0.x","underverse":"0.1.x"},"gitHead":"8a5896d9bdee81542a32e68053490224e488db3e","bugs":{"url":"https://github.com/observing/leverage/issues"},"homepage":"https://github.com/observing/leverage#readme","_id":"leverage@0.1.3","_shasum":"cdb7e583c8d362bc21c5a763d36171e97191bb34","_from":".","_npmVersion":"3.6.0","_nodeVersion":"4.2.4","_npmUser":{"name":"swaagie","email":"info@martijnswaagman.nl"},"dist":{"shasum":"cdb7e583c8d362bc21c5a763d36171e97191bb34","tarball":"https://registry.npmjs.org/leverage/-/leverage-0.1.3.tgz","integrity":"sha512-2nTbiQs6LOFFaYC9n3MrNwT86nTDiUVmdjjn20OhZXkdRnD0A3J+L3yWNPkuIqYLba9TNHdazU4e04TxCIusvw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC56skaIDUXskvMRUebDnqKjTMC8lQjuT3DUOa9jp+zNgIgVAtUPy3n5zBzsRi/J9sD2bEIGg3DYT0P42lkW3sDF8s="}]},"maintainers":[{"name":"3rdeden","email":"npm@3rd-Eden.com"},{"name":"swaagie","email":"info@martijnswaagman.nl"},{"name":"v1","email":"npm@3rd-Eden.com"}],"_npmOperationalInternal":{"host":"packages-13-west.internal.npmjs.com","tmp":"tmp/leverage-0.1.3.tgz_1458560315097_0.6660565978381783"}}},"readme":"# leverage\n\n[![Version npm][npm-leverage-badge]][npm-leverage][![Build Status][travis-leverage-badge]][travis-leverage][![Dependencies][david-leverage-badge]][david-leverage][![Coverage Status][coverage-leverage-badge]][coverage-leverage]\n\n[npm-leverage-badge]: https://img.shields.io/npm/v/leverage.svg?style=flat-square\n[npm-leverage]: http://browsenpm.org/package/leverage\n[travis-leverage-badge]: https://img.shields.io/travis/observing/leverage/master.svg?style=flat-square\n[travis-leverage]: https://travis-ci.org/observing/leverage\n[david-leverage-badge]: https://img.shields.io/david/observing/leverage.svg?style=flat-square\n[david-leverage]: https://david-dm.org/observing/leverage\n[coverage-leverage-badge]: https://img.shields.io/coveralls/observing/leverage/master.svg?style=flat-square\n[coverage-leverage]: https://coveralls.io/r/observing/leverage?branch=master\n\nLeverage is an abstraction on top of the fabulous `redis` client for Node.js. It\nmakes it much easier to work with lua scripting in Redis as well as provide some\nsome missing features in Redis through the power of lua scripting.\n\n### Installation\n\nThe package should be installed through npm, which is installed by default when\nyou download node.js\n\n```\nnpm install leverage --save\n```\n\n### Usage\n\nTo introduce these methods, the module searches for a `lua` or `leverage` folder\nin the root of your application folder (which contains the `node_modules` folder\nthat has this module installed). It only accepts files with a `.lua` extension.\nThese files will be introduced as methods on the `Leverage` prototype. So if you\nhave a `hello.lua` file in the `leverage` folder we will automatically make a\n`leverage.hello()` method.\n\nBecause we are introducing the scripts as methods in the `Leverage.prototype`\nthere are a couple of names that blocked for usage or they would destroy the\nmodules internals. We've made sure that most of internals of this module are\nnamespaced user the `_` property but there are however a couple methods exposed\non the prototype:\n\n- `_` Our private internal namespace for logic and options.\n- `readyState` Which indicates if everything is loaded correctly.\n- `publish` For our improved Pub/Sub.\n- `subscribe` For our improved Pub/Sub.\n- `unsubscribe` Unsubscribe from our Pub/Sub channel.\n- `destroy` For closing all used/wrapped Redis connections.\n- [All EventEmitter methods][EE] and [it's private properties][EEprivate]\n\nAnd just to be save, don't use methods that are prefixed with an underscore\nwhich will just protect you possible private node internals. Other then these\nproperties and methods your save to anything you want as we will just remove all\nforbidden chars, numbers from your script name and transform it to lowercase.\n\n[EE]: http://nodejs.org/api/events.html#events_class_events_eventemitter\n[EEprivate]: https://github.com/joyent/node/blob/master/lib/events.js#L26-L37\n\nTo initialize the module you need to provide it with at least one active Redis\nconnection:\n\n```js\nvar Leverage = require('leverage')\n , redis = require('redis').createClient();\n\nvar leverage = new Leverage(redis, { optional options });\n```\n\nIf you want to leverage the improved Pub/Sub capabilities you should supply 2\ndifferent clients. 1 connection will be used to publish the messages and execute\nthe commands while the other connection will be used to subscribe and there for\nblock the connection for writing.\n\n```js\nvar Leverage = require('leverage')\n , pub = require('redis').createClient()\n , sub = require('redis').createClient();\n\nvar leverage = new Leverage(pub, sub, { optional options });\n```\n\nIt might be possible that you want to add scripts from a different folder then\nour pre-defined folder locations. We've added a `Leverage.introduce` which you\ncan use to add scripts. The scripts that are added should be added to the\n`Leverage.scripts` array and you should add the scripts **BEFORE** you construct\na new Leverage instance.\n\n```js\nvar Leverage = require('leverage');\n\n//\n// Give the method the path of your lua files and the object or in our case the\n// prototype where you want to introduce the methods.\n//\nvar scripts = Leverage.introduce('/path/to/your/custom/directory', Leverage.prototype);\n\n//\n// IMPORTANT: Add the returned array of added scripts to our Leverage.scipts as\n// are checked during the bootstapping of the Leverage instance.\n//\nLeverage.scripts = Leverage.scripts.concat(scripts);\n```\n\nFYI: The `Leverage.introduce` methods returns an array with following data\nstructure:\n\n```\n{\n name: 'hello',\n args: {\n KEYS: 2,\n ARGV: 2\n },\n path: '/usr/wtf/path/to/file/hello.lua',\n code: 'local foo = KEYS[0]\\nlocal bar = KEYS[1] .. etc ..'\n}\n```\n\nWe we attempt to load in the lua scripts in to the Redis server we attempt to\nparse the script to automatically detect how many keys that should be send to\nthe server. If your code isn't to magical it should just parse it correctly and\nset the amount of KEYS and ARGV's of your script. There might be edge cases\nwhere you are iterating over the keys and args or we just fail to correctly\nparse your lua code because you a frigging lua wizard. For these edge cases you\ncan supply every generated method with a number. This number should represent\nthe amount of KEYS you are sending to your scripts.\n\n```js\nleverage.customscript(2, 'KEY1', 'KEY2', 'ARGS', 'ARGS', fn);\n```\n\nBut doing this every time can be a bit wasteful that's why you can also just\ntell us once and the module will memorize it for you so all other calls will\njust use the same amount of keys.\n\n```js\nleverage.customscript(2);\nleverage.otherscript(10);\nleverage.anotherscript(3);\n\n//\n// You can now call the scripts without the needed key amount argument.\n//\nleverage.customscript('KEY1', 'KEY2', 'ARGS', 'ARGS', fn);\n```\n\n#### Options\n\nThe following options are available, most of these apply to the improved Pub/Sub\nsystem.\n\n
\n
namespace
\n
\n

\n The namespace is used to prefix all keys that are set by this module\n inside of your redis installation. This way you can prevent conflicts from\n happening. It defaults to leverage\n

\n
\n\n
SHA1
\n
\n

\n SHA1 can be provided a preconfigured object that contains references to\n all method -> SHA1 mappings. Only change this if you know what the fuck\n you are doing. If this is not set we will just check your redis server to\n find out of the script has been loaded in the internal cache.\n

\n
\n\n
backlog
\n
\n

\n How many messages can we store for the pub/sub connection relaiblity if\n you are sending a lot of message per second you might want to set this to\n a higher number then you would with lower rate messages. It defaults to\n 10000. The messages are stored using FIFO so if you are\n storing to much messages it will automatically override older keys.\n

\n
\n\n
expire
\n
\n

\n To make sure that we don't leave to much crap in your database all stored\n messages are provided with a expire value. So the messages can be killed\n in 2 ways, either by an overflow of the backlog or by an expired key. The\n default expiree is 1000.\n

\n
\n
\n\n### Pub/Sub\n\nOur Pub/Sub wrapper provides a reliable Pub/Sub implementation on top of the\nfire and forget Pub/Sub implementation of redis. This is done by leveraging (ooh\nsee what I did there ;)) lua scripts.\n\n#### leverage.publish(channel, message, [callback])\n\nPublishing is as easy as:\n\n```js\nleverage.publish(channel, message, function (err, id) {\n // optional error and the unique id of the message\n});\n```\n\nThe callback is optional, but I would advice you to use it so you know which id\nyour message has and if it was send without any issues. When you publish a\nmessage the following events take place:\n\n1. We increase a unique counter for the given channel so we have a unique `id`\n for the message.\n2. Create a `packet` which contains the message and the id of the message.\n3. The package is stored as simple key/value where they key contains the channel\n and the unique `id`.\n4. The packet is published to the channel.\n\n#### leverage.subscribe(channel, { options })\n\nThe subscription command has a bit of different syntax then you are used to. It\naccepts a second argument which can be used to configure the reliablity of the\nPub/Sub channel:\n\n```js\nleverage.subscribe('channel', { options });\n```\n\nThe subscription command can be configured with:\n\n
\n
ordered
\n
\n

\n Force ordered delivery of messages. If a message is dropped all received\n messages will be queued until the missing message is retrieved again and\n then the queue is flushed again. Defaults to false.\n

\n
\n\n
bailout
\n
\n

\n When we received an error while processing and receiving messages we can\n stop the subscription as we can no longer guarantee so the sensible thing\n to do would be giving up and unsubscribing from the channel and stop with\n all processing. Defaults to true.\n

\n
\n\n
replay
\n
\n

\n How many events should we retrieve when we join the channel for the first\n time as it might happen that we've received a message right before we\n subscribed. Defaults to 0.\n

\n
\n
\n\nWhen you join a channel the follwing events take place:\n\n1. The current id is retrieved.\n2. Older messages are retrieved if needed\n3. A packet is send back which contains all fetched messages and the current id.\n\nOnce you are subscribed to a channel the messages will be emitted on the\n`leverage` instance. There are a couple of different events emitted:\n\n- `::message` A message has been received.\n- `::bailout` We've received an error and are bailing out.\n- `::error` The channel received an error.\n- `::online` The channel has started processing messages.\n- `::unsubscribe` The channel has been unsubscribed.\n\n`` is the name of the channel that you've subscribed to.\n\n```js\nleverage.subscribe('foo').on('foo::message', function onmessage(message, id) {\n console.log('Received the following message: ', message);\n console.log('The message had the following id: ', id);\n});\n\nleverage.on('foo::bailout', function bailout(e) {\n console.log('The following error caused the bailout', e);\n});\n\nleverage.on('foo::error', function error(e) {\n console.log('We received an error', e);\n console.log('This was emitted before a bailout, if bailouts were enabled');\n});\n```\n\n#### leverage.unsubscribe(channel, [callback])\n\nUnsubscribe from the channel, nothing special here.\n\n```js\nleverage.unsubscribe('foo', function unsubscribed(err) {\n ..\n});\n```\n\nThis also triggers the `::unsubscribe` event.\n\n#### Note:\n\nAll these operations happen atomicly and are namespaced under the namespace that\nyou configured `Leverage` with. So you cannot (and should not) publish to\nchannels that are not wrapper by Leverage.\n\n## LICENSE\n\nMIT\n","maintainers":[{"email":"info@martijnswaagman.nl","name":"swaagie"},{"email":"npm@3rd-Eden.com","name":"v1"},{"email":"npm@3rd-Eden.com","name":"3rdeden"}],"time":{"modified":"2022-06-19T11:54:36.430Z","created":"2013-05-22T18:19:32.544Z","0.0.0":"2013-05-22T18:19:44.203Z","0.0.1":"2013-05-23T20:39:29.639Z","0.0.2":"2013-05-24T12:43:47.249Z","0.0.3":"2013-05-27T07:59:51.023Z","0.0.4":"2013-11-09T22:50:31.255Z","0.0.5":"2014-08-28T11:25:20.842Z","0.1.0":"2014-10-23T12:03:16.424Z","0.1.1":"2015-03-11T08:40:59.123Z","0.1.2":"2015-03-11T08:42:24.498Z","0.1.3":"2016-03-21T11:38:37.506Z"},"author":{"name":"Arnout Kazemier","email":"opensource@observe.it"},"repository":{"type":"git","url":"git://github.com/observing/leverage.git"},"users":{"justinfreitag":true},"homepage":"https://github.com/observing/leverage#readme","keywords":["redis","pub","sub","pub/sub","message","queues","lua","scripting","leverage"],"bugs":{"url":"https://github.com/observing/leverage/issues"},"license":"MIT","readmeFilename":"README.md"}