{"id":15416756,"url":"https://github.com/mjancarik/to-aop","last_synced_at":"2025-05-07T16:09:09.212Z","repository":{"id":47678714,"uuid":"142604972","full_name":"mjancarik/to-aop","owner":"mjancarik","description":"Library for aspect-oriented programming with JavaScript using ES6 Proxy","archived":false,"fork":false,"pushed_at":"2024-08-29T15:55:55.000Z","size":150,"stargazers_count":17,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-07T16:08:56.574Z","etag":null,"topics":["aop","aspect-oriented-programming","aspects","hook-framework","hooks","javascirpt","javascript-prototypes","javascript-proxy"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mjancarik.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-27T17:21:16.000Z","updated_at":"2024-08-29T15:55:57.000Z","dependencies_parsed_at":"2024-10-19T22:27:01.509Z","dependency_job_id":null,"html_url":"https://github.com/mjancarik/to-aop","commit_stats":{"total_commits":108,"total_committers":3,"mean_commits":36.0,"dds":0.01851851851851849,"last_synced_commit":"b3194e54f6c6f3a206444489e44625634619b964"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjancarik%2Fto-aop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjancarik%2Fto-aop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjancarik%2Fto-aop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mjancarik%2Fto-aop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mjancarik","download_url":"https://codeload.github.com/mjancarik/to-aop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252912996,"owners_count":21824066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aop","aspect-oriented-programming","aspects","hook-framework","hooks","javascirpt","javascript-prototypes","javascript-proxy"],"created_at":"2024-10-01T17:13:46.128Z","updated_at":"2025-05-07T16:09:09.129Z","avatar_url":"https://github.com/mjancarik.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# to-aop\n\n[![Coverage Status](https://coveralls.io/repos/github/mjancarik/to-aop/badge.svg?branch=master)](https://coveralls.io/github/mjancarik/to-aop?branch=master)\n[![NPM package version](https://img.shields.io/npm/v/to-aop/latest.svg)](https://www.npmjs.com/package/to-aop)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n\nThe to-aop module help you with applying [Aspect Oriented Programming](https://www.cs.ubc.ca/~gregor/papers/kiczales-ECOOP1997-AOP.pdf) to JavaScript. It use under the hood [ES Proxy](https://ponyfoo.com/articles/es6-proxies-in-depth) for object same as other similar modules. It allow you hook class without creating new instance as well. It use javascript prototype for that.\n\nFor example I am using it for adding hooks to production code where all debug code is missing. I don't have got access to instance but I have only class constructor. But usage is unlimited.\n\nMore articles about AOP:\n1. https://blog.mgechev.com/2015/07/29/aspect-oriented-programming-javascript-aop-js/\n2. https://hackernoon.com/aspect-oriented-programming-in-javascript-es5-typescript-d751dda576d0\n\nExamples:\n1. https://github.com/mjancarik/shallow-with-context/blob/master/src/shallowWithContext.js\n2. https://github.com/seznam/ima/blob/master/packages/devtools/src/services/defaultSettings.json\n\n## Installation\n\n```bash\nnpm i to-aop --save\n```\n\n## Usage\n\nEasy example for native Date.now method.\n\n``` javascript\nimport { aop, hookName, createHook } from 'to-aop';\n\nconst nowHook = createHook(hookName.aroundMethod, 'now', (args) =\u003e {\n    return 1;\n});\n\naop(Date, nowHook);\n\nDate.now() // returns 1\n```\n\nOther example with more hooks for your defined class.\n\n``` javascript\n// a.js\nexport default class A {\n  constructor(variable) {\n    this.variable = variable;\n  }\n\n  method() {\n    return this.variable;\n  }\n\n  notHookedMethod() {\n    return 'not hook';\n  }    \n}\n```\n\n#### Applying AOP to class\n\nYou can use it for creating hook to your favorite framework or your own application without modification source code.\n\n``` javascript\nimport { aop, hookName, createHook, unAop } from 'to-aop';\nimport A from './a';\n\nconst classHookBefore = createHook(\n  hookName.beforeMethod,\n  /^(method)$/,\n  ({ target, object, property, context, args, meta }) =\u003e {\n    //call your own hook\n    meta.startTime = performance.now();\n    console.log(\n      `Instance of ${target.name} call \"${property}\"\nwith arguments ${args \u0026\u0026 args.length ? args : '[]'}.`\n    );\n  }\n);\n\nconst classHookAfter = createHook(\n  hookName.afterMethod,\n  /^(method)$/,\n  ({ target, object, property, context, args, payload, meta }) =\u003e {\n    //call your own hook\n    console.log(\n      `Instance of ${target.name} call \"${property}\"\nwith arguments ${args \u0026\u0026 args.length ? args : '[]'}\nand return value is \"${payload}\" took ${performance.now() - meta.startTime}.`\n    );\n  }\n);\n\nconst hooks = Object.assign({}, classHookBefore, classHookAfter);\n\naop(\n  A,\n  hooks\n); // bind hook to class\nconst a = new A('my hook');\n\na.method(); // log: 'Instance of A call \"method\" with arguments [] and return value is \"my hook\".', returns: 'my hook'\na.notHookedClassMethod(); // returns: 'not hook'\n\nunAop(A);\na.method(); // returns: 'my hook'\na.notHookedClassMethod(); // returns: 'not hook'\n\n```\n\n#### Applying AOP to instance or object\n\n```javascript\nimport { aop, hookName, createHook, unAop } from 'to-aop';\nimport A from './a';\n\nconst instanceHook = createHook(\n  hookName.afterMethod,\n  /^(method)$/,\n  ({ target, object, property, context, args, payload, meta }) =\u003e {\n    console.log(\n      `Instance of ${object.constructor.name} call \"${property}\"\nwith arguments ${args \u0026\u0026 args.length ? args : '[]'}\nand return value is \"${payload}\".`\n    );\n  }\n);\n\nconst a = new A('my hook');\nconst hookedInstance = aop(a, instanceHook); // bind hook to instance\n\nhookedInstance.method(); // log: 'Instance of A call \"method\" with arguments [] and return value is \"my hook.', returns: 'my hook'\nhookedInstance.notHookedClassMethod(); // returns: 'not hook'\n\nunAop(a);\na.method(); // returns: 'my hook'\na.notHookedClassMethod(); // returns: 'not hook'\n```\n\n## Documentation\n\n### createHook(hookName, regular, callbackHook)\n\n  - (string) hookName - set of hooks\n  - (string, regexp, Array, function) regular - condition for filtering\n  - (function) callbackHook - your defined action\n\n### aop(target, pattern, settings)\n\n  - (class, object) - target for hooks\n  - (Object\u003cstring, Array\u003cfunction\u003e\u003e) - pattern of hooks\n  - {Object} settings\n  - {booelan} [settings.constructor=false] - allow hook class constructor\n\n### unAop(target)\n\n  - (class, object) - target for hooks\n\n## Hooks API\n\nWe implemented base set of hooks which you can use for AOP.\n\n1. beforeMethod\n2. afterMethod\n3. aroundMethod\n4. beforeGetter\n5. afterGetter\n6. aroundGetter\n7. beforeSetter\n8. afterSetter\n9. aroundSetter\n\n```javascript\nimport { hookName } from 'to-aop';\n\n// hookName.(beforeMethod|afterMethod|...)\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjancarik%2Fto-aop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmjancarik%2Fto-aop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmjancarik%2Fto-aop/lists"}