- Functions
- [AllowGetTarget](#allowgettarget)
- [DefaultToPrimitive](#defaulttoprimitive)
- [DefaultToStringTag](#defaulttostringtag)
- [Mapped](#mapped)
- [TargetAsThis](#targetasthis)
- [getTarget](#gettarget)proxy-handler-decorators
Class decorators for proxy handlers.!npm packagenpm-imgnpm-url !Build Statusbuild-imgbuild-url !Downloadsdownloads-imgdownloads-url !Issuesissues-imgissues-url !Code Coveragecodecov-imgcodecov-url !Commitizen Friendlycommitizen-imgcommitizen-url !Semantic Releasesemantic-release-imgsemantic-release-url
ExampleA proxy to transform an array, prepending a '!' character to each element.
```typescript doctest import { getTarget, AllowGetTarget, Mapped, DefaultToPrimitive, DefaultToStringTag, TargetAsThis, } from 'proxy-handler-decorators'; import { DefaultProxyHandler } from 'default-proxy-handler';
let counter = 0; function addBang(words: string): string { counter++; return words.map((word) =>
${word}!);
}@AllowGetTarget @Mapped>(addBang) @DefaultToPrimitive @DefaultToStringTag @TargetAsThis class MappedProxyHandler extends DefaultProxyHandler> {} const mappedProxyHandler = new MappedProxyHandler();
const proxy = new Proxy('hello', 'world', mappedProxyHandler); expect(counter).toBe(0); expect(proxy).toEqual('hello!', 'world!'); expect(counter).toBeGreaterThan(0);
counter = 0; expect(proxy).toEqual('hello!', 'world!'); expect(counter).toBeGreaterThan(0);
expect(getTarget(proxy)).toEqual('hello', 'world'); ```
Functions
AllowGetTarget
▸ AllowGetTarget<T, SuperClass\>(superClass): SuperClassThe decorator to enable getTarget function.
Type parameters
| Name | Type | | :------ | :------ | |T | extends object |
| SuperClass | extends (...args: any) => ProxyHandler<T\> |Parameters
| Name | Type | | :------ | :------ | |superClass | SuperClass |Returns
SuperClassDefined in
index.ts:194DefaultToPrimitive
▸ DefaultToPrimitive<T, SuperClass\>(superClass): SuperClassA decorator to add a default implementation of
[Symbol.toPrimitive] method
to the proxy.Type parameters
| Name | Type | | :------ | :------ | |T | extends object |
| SuperClass | extends (...args: any) => ProxyHandler<T\> |Parameters
| Name | Type | | :------ | :------ | |superClass | SuperClass |Returns
SuperClassDefined in
index.ts:114DefaultToStringTag
▸ DefaultToStringTag<T, SuperClass\>(superClass): SuperClassA decorator to add a default implementation of
[Symbol.toStringTag] method
to the proxy.Type parameters
| Name | Type | | :------ | :------ | |T | extends object |
| SuperClass | extends (...args: any) => ProxyHandler<T\> |Parameters
| Name | Type | | :------ | :------ | |superClass | SuperClass |Returns
SuperClassDefined in
index.ts:150Mapped
▸ Mapped<T\>(mapper): (proxyHandlerConstructor: (...args: any) => ProxyHandler<T\>) => voidType parameters
| Name | Type | | :------ | :------ | |T | extends object |Parameters
| Name | Type | | :------ | :------ | |mapper | (from: T) => T |Returns
fn▸ (
proxyHandlerConstructor): voidParameters
| Name | Type | | :------ | :------ | |proxyHandlerConstructor | (...args: any) => ProxyHandler<T\> |Returns
voidDefined in
index.ts:212TargetAsThis
▸ TargetAsThis<T, SuperClass\>(superClass): SuperClassA decorator to bind
this to the proxy target for all instance methods on
the proxy.Type parameters
| Name | Type | | :------ | :------ | |T | extends object |
| SuperClass | extends (...args: any) => ProxyHandler<T\> |Parameters
| Name | Type | | :------ | :------ | |superClass | SuperClass |Returns
SuperClassDefined in
index.ts:78getTarget
▸ getTarget<T\>(maybeProxy): T \| undefinedReturns the proxy target if
proxy is a proxy and its proxy handler has the
AllowGetTarget decorator, or undefined otherwise.Type parameters
| Name | | :------ | |T |Parameters
| Name | Type | | :------ | :------ | |maybeProxy | T |Returns
T \| undefined
