Patcher
Patcher is a utility class for modifying existing functions. Instance is accessible through the BdApi. This is extremely useful for modifying the internals of Discord by adjusting return value or React renders, or arguments of internal functions.
Properties
Methods
after
This method patches onto another function, allowing your code to run instead. Using this, you are also able to modify the return value, using the return of your code instead.
| Parameter | Type | Description |
|---|---|---|
| caller | string | Name of the caller of the patch function. |
| moduleToPatch | object | Object with the function to be patched. Can also be an object's prototype. |
| functionName | string | Name of the function to be patched. |
| callback | function | Function to run after the original method. The function is given the this context, the arguments of the original function, and the return value of the original function. |
Returns: function - Function that cancels the original patch.
before
This method patches onto another function, allowing your code to run beforehand. Using this, you are also able to modify the incoming arguments before the original method is run.
| Parameter | Type | Description |
|---|---|---|
| caller | string | Name of the caller of the patch function. |
| moduleToPatch | object | Object with the function to be patched. Can also be an object's prototype. |
| functionName | string | Name of the function to be patched. |
| callback | function | Function to run before the original method. The function is given the this context and the arguments of the original function. |
Returns: function - Function that cancels the original patch.
getPatchesByCaller
Returns all patches by a particular caller. The patches all have an unpatch() method.
| Parameter | Type | Description |
|---|---|---|
| caller | string | ID of the original patches |
Returns: Array.<function()> - Array of all the patch objects.
instead
This method patches onto another function, allowing your code to run instead. Using this, you are also able to modify the return value, using the return of your code instead.
| Parameter | Type | Description |
|---|---|---|
| caller | string | Name of the caller of the patch function. |
| moduleToPatch | object | Object with the function to be patched. Can also be an object's prototype. |
| functionName | string | Name of the function to be patched. |
| callback | function | Function to run before the original method. The function is given the this context, arguments of the original function, and also the original function. |
Returns: function - Function that cancels the original patch.
unpatchAll
Automatically cancels all patches created with a specific ID.
| Parameter | Type | Description |
|---|---|---|
| caller | string | ID of the original patches |
Returns: void