{"id":16696650,"url":"https://github.com/atry/proxy-handler-decorators","last_synced_at":"2026-04-22T08:31:28.157Z","repository":{"id":65308298,"uuid":"589134829","full_name":"Atry/proxy-handler-decorators","owner":"Atry","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-16T17:46:10.000Z","size":1160,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-21T11:03:00.444Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/Atry.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}},"created_at":"2023-01-15T07:03:40.000Z","updated_at":"2023-01-16T03:38:50.000Z","dependencies_parsed_at":"2023-02-10T05:16:26.813Z","dependency_job_id":null,"html_url":"https://github.com/Atry/proxy-handler-decorators","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":"ryansonshine/typescript-npm-package-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Atry%2Fproxy-handler-decorators","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Atry%2Fproxy-handler-decorators/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Atry%2Fproxy-handler-decorators/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Atry%2Fproxy-handler-decorators/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Atry","download_url":"https://codeload.github.com/Atry/proxy-handler-decorators/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243515567,"owners_count":20303258,"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":[],"created_at":"2024-10-12T17:44:28.025Z","updated_at":"2025-12-28T09:23:02.777Z","avatar_url":"https://github.com/Atry.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n\n- [proxy-handler-decorators](#proxy-handler-decorators)\n  - [Functions](#functions)\n    - [AllowGetTarget](#allowgettarget)\n    - [DefaultToPrimitive](#defaulttoprimitive)\n    - [DefaultToStringTag](#defaulttostringtag)\n    - [Mapped](#mapped)\n    - [TargetAsThis](#targetasthis)\n    - [getTarget](#gettarget)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n\n\u003ca name=\"readmemd\"\u003e\u003c/a\u003e\n\n# proxy-handler-decorators\n\nClass decorators for proxy handlers.\n\n[![npm package][npm-img]][npm-url]\n[![Build Status][build-img]][build-url]\n[![Downloads][downloads-img]][downloads-url]\n[![Issues][issues-img]][issues-url]\n[![Code Coverage][codecov-img]][codecov-url]\n[![Commitizen Friendly][commitizen-img]][commitizen-url]\n[![Semantic Release][semantic-release-img]][semantic-release-url]\n\n[build-img]:https://github.com/Atry/proxy-handler-decorators/actions/workflows/release.yml/badge.svg\n[build-url]:https://github.com/Atry/proxy-handler-decorators/actions/workflows/release.yml\n[downloads-img]:https://img.shields.io/npm/dt/proxy-handler-decorators\n[downloads-url]:https://www.npmtrends.com/proxy-handler-decorators\n[npm-img]:https://img.shields.io/npm/v/proxy-handler-decorators\n[npm-url]:https://www.npmjs.com/package/proxy-handler-decorators\n[issues-img]:https://img.shields.io/github/issues/Atry/proxy-handler-decorators\n[issues-url]:https://github.com/Atry/proxy-handler-decorators/issues\n[codecov-img]:https://codecov.io/gh/Atry/proxy-handler-decorators/branch/main/graph/badge.svg\n[codecov-url]:https://codecov.io/gh/Atry/proxy-handler-decorators\n[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n[semantic-release-url]:https://github.com/semantic-release/semantic-release\n[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\n[commitizen-url]:http://commitizen.github.io/cz-cli/\n\n**`Example`**\n\nA proxy to transform an array, prepending a '!' character to each element.\n\n```typescript doctest\nimport {\n  getTarget,\n  AllowGetTarget,\n  Mapped,\n  DefaultToPrimitive,\n  DefaultToStringTag,\n  TargetAsThis,\n} from 'proxy-handler-decorators';\nimport { DefaultProxyHandler } from 'default-proxy-handler';\n\nlet counter = 0;\nfunction addBang(words: string[]): string[] {\n  counter++;\n  return words.map((word) =\u003e `${word}!`);\n}\n\n@AllowGetTarget\n@Mapped\u003cstring[]\u003e(addBang)\n@DefaultToPrimitive\n@DefaultToStringTag\n@TargetAsThis\nclass MappedProxyHandler extends DefaultProxyHandler\u003cstring[]\u003e {}\nconst mappedProxyHandler = new MappedProxyHandler();\n\nconst proxy = new Proxy(['hello', 'world'], mappedProxyHandler);\nexpect(counter).toBe(0);\nexpect(proxy).toEqual(['hello!', 'world!']);\nexpect(counter).toBeGreaterThan(0);\n\ncounter = 0;\nexpect(proxy).toEqual(['hello!', 'world!']);\nexpect(counter).toBeGreaterThan(0);\n\nexpect(getTarget(proxy)).toEqual(['hello', 'world']);\n```\n\n## Functions\n\n### AllowGetTarget\n\n▸ **AllowGetTarget**\u003c`T`, `SuperClass`\\\u003e(`superClass`): `SuperClass`\n\nThe decorator to enable [getTarget](#gettarget) function.\n\n#### Type parameters\n\n| Name | Type |\n| :------ | :------ |\n| `T` | extends `object` |\n| `SuperClass` | extends (...`args`: `any`[]) =\u003e `ProxyHandler`\u003c`T`\\\u003e |\n\n#### Parameters\n\n| Name | Type |\n| :------ | :------ |\n| `superClass` | `SuperClass` |\n\n#### Returns\n\n`SuperClass`\n\n#### Defined in\n\n[index.ts:194](https://github.com/Atry/proxy-handler-decorators/blob/8586f48/src/index.ts#L194)\n\n___\n\n### DefaultToPrimitive\n\n▸ **DefaultToPrimitive**\u003c`T`, `SuperClass`\\\u003e(`superClass`): `SuperClass`\n\nA decorator to add a default implementation of `[Symbol.toPrimitive]` method\nto the proxy.\n\n#### Type parameters\n\n| Name | Type |\n| :------ | :------ |\n| `T` | extends `object` |\n| `SuperClass` | extends (...`args`: `any`[]) =\u003e `ProxyHandler`\u003c`T`\\\u003e |\n\n#### Parameters\n\n| Name | Type |\n| :------ | :------ |\n| `superClass` | `SuperClass` |\n\n#### Returns\n\n`SuperClass`\n\n#### Defined in\n\n[index.ts:114](https://github.com/Atry/proxy-handler-decorators/blob/8586f48/src/index.ts#L114)\n\n___\n\n### DefaultToStringTag\n\n▸ **DefaultToStringTag**\u003c`T`, `SuperClass`\\\u003e(`superClass`): `SuperClass`\n\nA decorator to add a default implementation of `[Symbol.toStringTag]` method\nto the proxy.\n\n#### Type parameters\n\n| Name | Type |\n| :------ | :------ |\n| `T` | extends `object` |\n| `SuperClass` | extends (...`args`: `any`[]) =\u003e `ProxyHandler`\u003c`T`\\\u003e |\n\n#### Parameters\n\n| Name | Type |\n| :------ | :------ |\n| `superClass` | `SuperClass` |\n\n#### Returns\n\n`SuperClass`\n\n#### Defined in\n\n[index.ts:150](https://github.com/Atry/proxy-handler-decorators/blob/8586f48/src/index.ts#L150)\n\n___\n\n### Mapped\n\n▸ **Mapped**\u003c`T`\\\u003e(`mapper`): (`proxyHandlerConstructor`: (...`args`: `any`[]) =\u003e `ProxyHandler`\u003c`T`\\\u003e) =\u003e `void`\n\n#### Type parameters\n\n| Name | Type |\n| :------ | :------ |\n| `T` | extends `object` |\n\n#### Parameters\n\n| Name | Type |\n| :------ | :------ |\n| `mapper` | (`from`: `T`) =\u003e `T` |\n\n#### Returns\n\n`fn`\n\n▸ (`proxyHandlerConstructor`): `void`\n\n##### Parameters\n\n| Name | Type |\n| :------ | :------ |\n| `proxyHandlerConstructor` | (...`args`: `any`[]) =\u003e `ProxyHandler`\u003c`T`\\\u003e |\n\n##### Returns\n\n`void`\n\n#### Defined in\n\n[index.ts:212](https://github.com/Atry/proxy-handler-decorators/blob/8586f48/src/index.ts#L212)\n\n___\n\n### TargetAsThis\n\n▸ **TargetAsThis**\u003c`T`, `SuperClass`\\\u003e(`superClass`): `SuperClass`\n\nA decorator to bind `this` to the proxy target for all instance methods on\nthe proxy.\n\n#### Type parameters\n\n| Name | Type |\n| :------ | :------ |\n| `T` | extends `object` |\n| `SuperClass` | extends (...`args`: `any`[]) =\u003e `ProxyHandler`\u003c`T`\\\u003e |\n\n#### Parameters\n\n| Name | Type |\n| :------ | :------ |\n| `superClass` | `SuperClass` |\n\n#### Returns\n\n`SuperClass`\n\n#### Defined in\n\n[index.ts:78](https://github.com/Atry/proxy-handler-decorators/blob/8586f48/src/index.ts#L78)\n\n___\n\n### getTarget\n\n▸ **getTarget**\u003c`T`\\\u003e(`maybeProxy`): `T` \\| `undefined`\n\nReturns the proxy target if `proxy` is a proxy and its proxy handler has the\n[AllowGetTarget](#allowgettarget) decorator, or `undefined` otherwise.\n\n#### Type parameters\n\n| Name |\n| :------ |\n| `T` |\n\n#### Parameters\n\n| Name | Type |\n| :------ | :------ |\n| `maybeProxy` | `T` |\n\n#### Returns\n\n`T` \\| `undefined`\n\n#### Defined in\n\n[index.ts:187](https://github.com/Atry/proxy-handler-decorators/blob/8586f48/src/index.ts#L187)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatry%2Fproxy-handler-decorators","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatry%2Fproxy-handler-decorators","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatry%2Fproxy-handler-decorators/lists"}