{"_id":"@ardinsys/event-emitter","_rev":"2-0e5d90a8ba5024b704d00bd2edf1a3d6","name":"@ardinsys/event-emitter","dist-tags":{"latest":"2.0.0"},"versions":{"0.8.1":{"name":"@ardinsys/event-emitter","description":"Typesafe EventEmitter implementation.","repository":{"type":"git","url":"git+https://github.com/ardinsys/typesafe-event-emitter.git"},"license":"Apache 2.0","author":{"name":"ARDINSYS Zrt."},"version":"0.8.1","main":"./dist/index.umd.js","module":"./dist/index.es.js","types":"./dist/index.d.ts","scripts":{"dev":"vite","build":"tsc && vite build && tsc src/index.ts --declaration --emitDeclarationOnly --esModuleInterop --outDir dist","prepublishOnly":"npm run build","test":"vitest","coverage":"vitest run --coverage"},"publishConfig":{"access":"public"},"devDependencies":{"@types/node":"^18.11.13","@vitest/coverage-c8":"^0.25.7","typescript":"^4.9.4","vite":"^4.0.0","vitest":"^0.25.7"},"exports":{".":{"import":"./dist/index.umd.js","require":"./dist/index.es.js"}},"sideEffects":false,"gitHead":"180e47e09e6e98fbcd172d943cf7472ba350ec6c","bugs":{"url":"https://github.com/ardinsys/typesafe-event-emitter/issues"},"homepage":"https://github.com/ardinsys/typesafe-event-emitter#readme","_id":"@ardinsys/event-emitter@0.8.1","_nodeVersion":"16.18.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-s22r3pt+3IRTBYLJQylTzZPuYj7gAUHB2qXivuP7GKLhZ2iA8Z5pFXd5az2bGN4RjVQxz4c8RKP8gQPhi+mcjQ==","shasum":"921450b61489d3a571cff32328a2133618bf836c","tarball":"https://registry.npmjs.org/@ardinsys/event-emitter/-/event-emitter-0.8.1.tgz","fileCount":5,"unpackedSize":7600,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDFHe6dYHPeduTXLLWdN0OA8dKufWe6YLuzm7QRj0KeCwIhAKyScHGENCkd/NyNqVs9Wc3dy+L7JghxVeQ23/bwIma5"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjlwLwACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpk+BAAkPZLrfFxRm+oWDH/NoC7wZF7Pjsao65vOYs8X73dPbGInFQW\r\nK8mVY93TiOKOsrkbiii6pR+pU2HctY02wQQY3jIV7loIZ+N9Ci1BKS4xOBvP\r\nA8Thg4mZFPMBqDXsRVxesptQbMpDt0OF84de6qrASpBfpi/0dpWc52HHwjgp\r\nB8NIhZGS7RjXJ0wGZ8IhgN6VEbCuKum3gqMiOvr63y2D+RWVLfheAdX6s99D\r\nlna3kiFUH3ldneTvIh3Ql/gR5xWmqcTkH01CTCsw+tcVqp3/3Mqd5vudAxJJ\r\nYDcp1ICWNJklPHrMaMz2Kc0ufbfzNS0c/L6OICDO/a52xyW6RUkf3YtISkWI\r\n1lNax7S1U8UrzBlq2RVNpMhmKpTDwk1sg4hTQY6KmPKId9KNa96KvVXAuN0n\r\nsh+Mg+iF5w5s2m6frMp0N1GBVqda8RfUYWlyZjDl35Cdy06U5KCKmaOLCnHa\r\nNH/wHZ3dEkkon+yJgtBYN2DUngTgIAU+CfOOfxdN2EI67rTuZgwCMYDE1eek\r\n60Mps4PH0QrBLeWP9I3bLWtIe0pTusO51C8fkhW4T+oHrxyTby7myKAZM8Rs\r\nUAKw693oppHU6ItwJRP23hHQ7kz4NzFvknh+b6I/yOyEMT83U3eCxv8SgA/x\r\nF6tqewptmEMhES13ZYupMyhSVFarZT610CM=\r\n=xpI0\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ardinsys","email":"npm@ardinsys.eu"},"directories":{},"maintainers":[{"name":"ardinsys","email":"npm@ardinsys.eu"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/event-emitter_0.8.1_1670841072308_0.778087844701463"},"_hasShrinkwrap":false},"1.0.0":{"name":"@ardinsys/event-emitter","description":"Typesafe EventEmitter implementation.","repository":{"type":"git","url":"git+https://github.com/ardinsys/typesafe-event-emitter.git"},"license":"Apache 2.0","author":{"name":"ARDINSYS Zrt."},"version":"1.0.0","main":"./dist/index.umd.js","module":"./dist/index.es.js","types":"./dist/index.d.ts","scripts":{"dev":"vite","build":"tsc && vite build && tsc src/index.ts --declaration --emitDeclarationOnly --esModuleInterop --outDir dist","prepublishOnly":"npm run build","test":"vitest","coverage":"vitest run --coverage"},"publishConfig":{"access":"public"},"devDependencies":{"@types/node":"^18.11.13","@vitest/coverage-c8":"^0.25.7","typescript":"^4.9.4","vite":"^4.0.0","vitest":"^0.25.7"},"exports":{".":{"import":"./dist/index.umd.js","require":"./dist/index.es.js"}},"sideEffects":false,"gitHead":"99f1a82ee5e20347988ca51751b989100d30a541","bugs":{"url":"https://github.com/ardinsys/typesafe-event-emitter/issues"},"homepage":"https://github.com/ardinsys/typesafe-event-emitter#readme","_id":"@ardinsys/event-emitter@1.0.0","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-p1ciF09IpO9NI/wBfjzMdvkB12iMIhbG5QOyOfDBJOErFiE19KkfqRZ5qluDOFeE3S2hgNddTd3l4ij4cR8VGA==","shasum":"2ccae6b3dc8d8811fdf41789aa2894f8eee14563","tarball":"https://registry.npmjs.org/@ardinsys/event-emitter/-/event-emitter-1.0.0.tgz","fileCount":5,"unpackedSize":8098,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDvF6wQmnJ9CUfOGyNY9WgVnuIhQb39Q9hoS+mAOtYQGgIgOTXxMl9VpSfr9Eaz4rpptoeAQPOhWq3FaRFwFxVEZ8o="}]},"_npmUser":{"name":"ardinsys","email":"npm@ardinsys.eu"},"directories":{},"maintainers":[{"name":"ardinsys","email":"npm@ardinsys.eu"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/event-emitter_1.0.0_1685968791983_0.3277863696135983"},"_hasShrinkwrap":false},"2.0.0":{"name":"@ardinsys/event-emitter","description":"Typesafe EventEmitter implementation.","repository":{"type":"git","url":"git+https://github.com/ardinsys/typesafe-event-emitter.git"},"license":"Apache 2.0","author":{"name":"ARDINSYS Zrt."},"version":"2.0.0","main":"./dist/index.cjs.js","module":"./dist/index.es.js","types":"./dist/index.d.ts","scripts":{"dev":"vite","build":"tsc && vite build && tsc src/index.ts --declaration --emitDeclarationOnly --esModuleInterop --outDir dist","prepublishOnly":"npm run build","test":"vitest","coverage":"vitest run --coverage"},"publishConfig":{"access":"public"},"devDependencies":{"@types/node":"^18.11.13","@vitest/coverage-c8":"^0.25.7","typescript":"^4.9.4","vite":"^4.0.0","vitest":"^0.25.7"},"exports":{".":{"import":{"default":"./dist/index.es.js","types":"./dist/index.d.ts"},"require":{"default":"./dist/index.cjs.js","types":"./dist/index.d.ts"}}},"sideEffects":false,"gitHead":"52fbc3cb3cc4b400ad8cbbc1f3342b3a0b8b4fda","bugs":{"url":"https://github.com/ardinsys/typesafe-event-emitter/issues"},"homepage":"https://github.com/ardinsys/typesafe-event-emitter#readme","_id":"@ardinsys/event-emitter@2.0.0","_nodeVersion":"16.20.2","_npmVersion":"8.19.4","dist":{"integrity":"sha512-sX6IoyAsewta3qk9aNc+cSalfrtWkQsDflhPE6DRsbqhPwVEKOOkHB+NIw0Uw2OqgjpHjKNkeDKXpThulguWwA==","shasum":"4d739c2b937575f2c08a7ee7ea8093bcd3d5271e","tarball":"https://registry.npmjs.org/@ardinsys/event-emitter/-/event-emitter-2.0.0.tgz","fileCount":5,"unpackedSize":8019,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCntHIDzcMOMRw35LSkAaOv58TUXDJUVM2GCSCi0xBJEwIgQUeUF5KuYbZHClvsNCsogtqn5beUpZF9zFOD+bL388E="}]},"_npmUser":{"name":"ardinsys","email":"npm@ardinsys.eu"},"directories":{},"maintainers":[{"name":"ardinsys","email":"npm@ardinsys.eu"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/event-emitter_2.0.0_1700651192148_0.1860291053479417"},"_hasShrinkwrap":false}},"time":{"created":"2022-12-12T10:31:12.245Z","0.8.1":"2022-12-12T10:31:12.491Z","modified":"2023-11-22T11:06:32.554Z","1.0.0":"2023-06-05T12:39:52.196Z","2.0.0":"2023-11-22T11:06:32.367Z"},"maintainers":[{"name":"ardinsys","email":"npm@ardinsys.eu"}],"description":"Typesafe EventEmitter implementation.","homepage":"https://github.com/ardinsys/typesafe-event-emitter#readme","repository":{"type":"git","url":"git+https://github.com/ardinsys/typesafe-event-emitter.git"},"author":{"name":"ARDINSYS Zrt."},"bugs":{"url":"https://github.com/ardinsys/typesafe-event-emitter/issues"},"license":"Apache 2.0","readme":"# TypeSafe Event emitter\n\n## To create an emitter\n\nHere we have 2 generic type for the emmiter. First one specifies wich events can be emitted and the second one specifies which events can be subscribed to. (Actually these are just type restrictions, if you want, you can subscribe to any string :))\n\nUsually the more specific should extend the less specific one, beacuse you would only use 2 different types in bridge mode.\n\n```ts\ninterface EventPlayload {\n  test: string;\n  someOtherProperty: number;\n}\n\ninterface ListenEvent {\n  eventName: EventPayload;\n}\n\ninterface EmitEvent {\n  eventName: EventPayload;\n  otherEventName: EventPayload;\n}\n\nconst emitter = new EventEmitter<EmitEvent, ListenEvent>();\n```\n\n## Subscribe to an event\n\n```ts\nemitter.on(\"eventName\", (params) => {\n  // here params are correctly inferred as string from the ListenEvent type.\n  // Do something here\n});\n```\n\n## Subscribe to an event only once\n\n```ts\nemitter.once(\"eventName\", (params) => {\n  // here params are correctly inferred as string from the ListenEvent type.\n  // Do something here\n});\n```\n\n## Unscubscribe\n\n```ts\n// Removes function by reference\nemitter.off(\"eventName\", listener);\n```\n\n```ts\n// Every subscription returns a function which will remove the listener if you call it.\nconst unsubscribe = emitter.on(\"eventName\", (params) => {\n  // ...\n});\n\nunsubscribe();\n```\n\n## Emit an event\n\n```ts\nemitter.emit(\n  \"eventName\",\n  \"this is the payload which is need to be the type of string as it is inferred from the type EmitEvent\"\n);\n```\n\n## Event priority and stop propagation\n\nIf you define a priority for an event handler like this:\n\n```ts\nemitter.on(\"eventName\", (params) => console.log(params), 4);\n```\n\nThen this handler will be invoked before every other handler with a priority lower than 4.\n\n**Return this from a handler to break the invoke loop:**\n\n```ts\nemitter.on(\"eventName\", (params) => {\n  return { stopProgation: true };\n});\n```\n\n## Stop propagation for \"once\" events\n\nCode wise, it's basically the same.\n\n```ts\nemitter.once(\"eventName\", (params) => {\n  return { stopProgation: true };\n});\n```\n\nBut keep in mind, if this stop results in other \"once\" listeners not being invoked, then those listeners won't be deleted until they invoked once eventually.\n\n## Event emitter bridge\n\nIf you have some internal emitters which events need to be reemitted by an other emitter, then you can connect the two. Keep in mind, that this is a **one directional connection**.\n\n```ts\n// const emitter1 = emitter instance;\n// const emitter2 = emitter instance;\n\nemitter1.bridgeEmit(emitter2);\n```\n\nThe above code means, that emitter 2 will re-emit emitter1 events in itself. Nothing more, nothing less.\n\nIf you try to outsmart the system by writing the same code in the other direction as well..., I wish you good luck :)\n","readmeFilename":"README.md"}