default-proxy-handler

• default-proxy-handler
  • Interfaces
  • Variables
    • DefaultProxyHandler
• Interfaces
  • Interface: DefaultProxyHandler<T>
    • Type parameters
    • Hierarchy
    • Methods

default-proxy-handler

Interfaces

• DefaultProxyHandler

Variables

DefaultProxyHandler

• Const DefaultProxyHandler: <T>() => DefaultProxyHandler<T>

Type declaration

• new DefaultProxyHandler<T>(): DefaultProxyHandler<T>

A class of proxy handler that forward all properties and methods to the original target.

DefaultProxyHandler can be used as the super class for creating a more sophisticated proxy handler.

Example

A proxy whose handler is an DefaultProxyHandler should have the same properties as the original object.

import { DefaultProxyHandler } from 'default-proxy-handler';
const helloWorld = { hello: 'world' };
const helloWorldProxy = new Proxy(helloWorld, new DefaultProxyHandler());
expect(helloWorldProxy.hello).toBe(helloWorld.hello);

Example

You can extend DefaultProxyHandler to change the behavior of the proxy.

import { DefaultProxyHandler } from 'default-proxy-handler';

class RepeatedProxyHandler extends DefaultProxyHandler<{ hello: string }> {
  override get(target: { hello: string; }, p: string | symbol, receiver: any) {
    const originalValue: unknown =
      super.get(target, p, receiver);
    return [ originalValue, originalValue ];
  }
}

const helloWorld = { hello: 'world' };
const helloWorldProxy = new Proxy(helloWorld, new RepeatedProxyHandler());
expect(helloWorldProxy.hello).toEqual(['world', 'world']);

Type parameters

Name	Type
T	extends object

Returns

DefaultProxyHandler<T>

Defined in

index.ts:68

index.ts:77

Interfaces

Interface: DefaultProxyHandler<T>

Type parameters

Name	Type
T	extends object

Hierarchy

• ProxyHandler<T>

  ↳ DefaultProxyHandler

Methods

apply

▸ apply(target, thisArg, argArray): any

Parameters

Name	Type
target	T
thisArg	any
argArray	any[]

Returns

any

Overrides

ProxyHandler.apply

Defined in

index.ts:78

construct

▸ construct(target, argArray, newTarget): object

Parameters

Name	Type
target	T
argArray	any[]
newTarget	Function

Returns

object

Overrides

ProxyHandler.construct

Defined in

index.ts:80

defineProperty

▸ defineProperty(target, property, attributes): boolean

Parameters

Name	Type
target	T
property	string | symbol
attributes	PropertyDescriptor

Returns

boolean

Overrides

ProxyHandler.defineProperty

Defined in

index.ts:82

deleteProperty

▸ deleteProperty(target, p): boolean

Parameters

Name	Type
target	T
p	string | symbol

Returns

boolean

Overrides

ProxyHandler.deleteProperty

Defined in

index.ts:88

get

▸ get(target, p, receiver): any

Parameters

Name	Type
target	T
p	string | symbol
receiver	any

Returns

any

Overrides

ProxyHandler.get

Defined in

index.ts:90

getOwnPropertyDescriptor

▸ getOwnPropertyDescriptor(target, p): undefined | PropertyDescriptor

Parameters

Name	Type
target	T
p	string | symbol

Returns

undefined | PropertyDescriptor

Overrides

ProxyHandler.getOwnPropertyDescriptor

Defined in

index.ts:92

getPrototypeOf

▸ getPrototypeOf(target): null | object

Parameters

Name	Type
target	T

Returns

null | object

Overrides

ProxyHandler.getPrototypeOf

Defined in

index.ts:97

has

▸ has(target, p): boolean

Parameters

Name	Type
target	T
p	string | symbol

Returns

boolean

Overrides

ProxyHandler.has

Defined in

index.ts:99

isExtensible

▸ isExtensible(target): boolean

Parameters

Name	Type
target	T

Returns

boolean

Overrides

ProxyHandler.isExtensible

Defined in

index.ts:101

ownKeys

▸ ownKeys(target): ArrayLike<string | symbol>

Parameters

Name	Type
target	T

Returns

ArrayLike<string | symbol>

Overrides

ProxyHandler.ownKeys

Defined in

index.ts:103

preventExtensions

▸ preventExtensions(target): boolean

Parameters

Name	Type
target	T

Returns

boolean

Overrides

ProxyHandler.preventExtensions

Defined in

index.ts:105

set

▸ set(target, p, newValue, receiver): boolean

Parameters

Name	Type
target	T
p	string | symbol
newValue	any
receiver	any

Returns

boolean

Overrides

ProxyHandler.set

Defined in

index.ts:107

setPrototypeOf

▸ setPrototypeOf(target, v): boolean

Parameters

Name	Type
target	T
v	null | object

Returns

boolean

Overrides

ProxyHandler.setPrototypeOf

Defined in

index.ts:109