Skip to content

lib: document remaining ProxyHandler trap parameters #63738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Yogesh Kumar (yogesh968) wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −1
Open

lib: document remaining ProxyHandler trap parameters #63738

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/lib/es2015.proxy.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,24 @@ interface ProxyHandler<T extends object> {
/**
* A trap method for a function call.
* @param target The original callable object which is being proxied.
* @param thisArg The `this` argument for the call.
* @param argArray The list of arguments for the call.
*/
apply?(target: T, thisArg: any, argArray: any[]): any;

/**
* A trap for the `new` operator.
* @param target The original object which is being proxied.
* @param argArray The list of arguments for the constructor.
* @param newTarget The constructor that was originally called.
*/
construct?(target: T, argArray: any[], newTarget: Function): object;

/**
* A trap for `Object.defineProperty()`.
* @param target The original object which is being proxied.
* @param property The name or `Symbol` of the property to define.
* @param attributes The descriptor for the property being defined or modified.
* @returns A `Boolean` indicating whether or not the property has been defined.
*/
defineProperty?(target: T, property: string | symbol, attributes: PropertyDescriptor): boolean;
Expand Down Expand Up @@ -77,6 +82,7 @@ interface ProxyHandler<T extends object> {
* A trap for setting a property value.
* @param target The original object which is being proxied.
* @param p The name or `Symbol` of the property to set.
* @param newValue The new value of the property to set.
* @param receiver The object to which the assignment was originally directed.
* @returns A `Boolean` indicating whether or not the property was set.
*/
Expand All @@ -87,7 +93,7 @@ interface ProxyHandler<T extends object> {
* @param target The original object which is being proxied.
* @param newPrototype The object's new prototype or `null`.
*/
setPrototypeOf?(target: T, v: object | null): boolean;
setPrototypeOf?(target: T, newPrototype: object | null): boolean;
}

interface ProxyConstructor {
Expand Down