Last active
March 7, 2023 17:54
-
-
Save sunderee/60501382c46a1180e29aac810119a4fc to your computer and use it in GitHub Desktop.
Scope functions in TypeScript
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
// Source: https://github.com/thedaviddelta/scope-extensions-js | |
declare global { | |
interface Object { | |
/** | |
* Calls the specified function block with `this` value as its argument and returns its result | |
* @param block - The function to be executed with `this` as argument | |
* @returns `block`'s result | |
*/ | |
let<T, R>(this: T | null | undefined, block: (it: T) => R): R; | |
/** | |
* Calls the specified function block with `this` value as its argument and returns `this` value | |
* @param block - The function to be executed with `this` as argument | |
* @returns `this` | |
*/ | |
also<T>(this: T | null | undefined, block: (it: T) => void): T; | |
/** | |
* Calls the specified function block with `this` value as its receiver and returns its value | |
* @param block - The function to be executed with `this` as context | |
* @returns `block`'s result | |
*/ | |
run<T, R>(this: T | null | undefined, block: (this: T) => R): R; | |
/** | |
* Calls the specified function block with `this` value as its receiver and returns `this` value | |
* @param block - The function to be executed with `this` as context | |
* @returns `this` | |
*/ | |
apply<T>(this: T | null | undefined, block: (this: T) => void): T; | |
/** | |
* Returns `this` value if it satisfies the given predicate or `undefined` if it doesn't | |
* @param predicate - The function to be executed with `this` as argument and returns a truthy or falsy value | |
* @returns `this` or `undefined` | |
*/ | |
takeIf<T>( | |
this: T | null | undefined, | |
predicate: (it: T) => boolean | |
): T | undefined; | |
/** | |
* Returns `this` value if it does not satisfy the given predicate or `undefined` if it does | |
* @param predicate - The function to be executed with `this` as argument and returns a truthy or falsy value | |
* @returns `this` or `undefined` | |
*/ | |
takeUnless<T>( | |
this: T | null | undefined, | |
predicate: (it: T) => boolean | |
): T | undefined; | |
} | |
interface Number { | |
/** | |
* Calls the specified function block with `this` value as its argument and returns its result | |
* @param block - The function to be executed with `this` as argument | |
* @returns `block`'s result | |
*/ | |
let<R>(this: number | null | undefined, block: (it: number) => R): R; | |
/** | |
* Calls the specified function block with `this` value as its argument and returns `this` value | |
* @param block - The function to be executed with `this` as argument | |
* @returns `this` | |
*/ | |
also(this: number | null | undefined, block: (it: number) => void): number; | |
/** | |
* Calls the specified function block with `this` value as its receiver and returns its value | |
* @param block - The function to be executed with `this` as context | |
* @returns `block`'s result | |
*/ | |
run<R>(this: number | null | undefined, block: (this: number) => R): R; | |
/** | |
* Calls the specified function block with `this` value as its receiver and returns `this` value | |
* @param block - The function to be executed with `this` as context | |
* @returns `this` | |
*/ | |
apply( | |
this: number | null | undefined, | |
block: (this: number) => void | |
): number; | |
/** | |
* Returns `this` value if it satisfies the given predicate or `undefined` if it doesn't | |
* @param predicate - The function to be executed with `this` as argument and returns a truthy or falsy value | |
* @returns `this` or `undefined` | |
*/ | |
takeIf( | |
this: number | null | undefined, | |
predicate: (it: number) => boolean | |
): number | undefined; | |
/** | |
* Returns `this` value if it does not satisfy the given predicate or `undefined` if it does | |
* @param predicate - The function to be executed with `this` as argument and returns a truthy or falsy value | |
* @returns `this` or `undefined` | |
*/ | |
takeUnless( | |
this: number | null | undefined, | |
predicate: (it: number) => boolean | |
): number | undefined; | |
} | |
interface String { | |
/** | |
* Calls the specified function block with `this` value as its argument and returns its result | |
* @param block - The function to be executed with `this` as argument | |
* @returns `block`'s result | |
*/ | |
let<R>(this: string | null | undefined, block: (it: string) => R): R; | |
/** | |
* Calls the specified function block with `this` value as its argument and returns `this` value | |
* @param block - The function to be executed with `this` as argument | |
* @returns `this` | |
*/ | |
also(this: string | null | undefined, block: (it: string) => void): string; | |
/** | |
* Calls the specified function block with `this` value as its receiver and returns its value | |
* @param block - The function to be executed with `this` as context | |
* @returns `block`'s result | |
*/ | |
run<R>(this: string | null | undefined, block: (this: string) => R): R; | |
/** | |
* Calls the specified function block with `this` value as its receiver and returns `this` value | |
* @param block - The function to be executed with `this` as context | |
* @returns `this` | |
*/ | |
apply( | |
this: string | null | undefined, | |
block: (this: string) => void | |
): string; | |
/** | |
* Returns `this` value if it satisfies the given predicate or `undefined` if it doesn't | |
* @param predicate - The function to be executed with `this` as argument and returns a truthy or falsy value | |
* @returns `this` or `undefined` | |
*/ | |
takeIf( | |
this: string | null | undefined, | |
predicate: (it: string) => boolean | |
): string | undefined; | |
/** | |
* Returns `this` value if it does not satisfy the given predicate or `undefined` if it does | |
* @param predicate - The function to be executed with `this` as argument and returns a truthy or falsy value | |
* @returns `this` or `undefined` | |
*/ | |
takeUnless( | |
this: string | null | undefined, | |
predicate: (it: string) => boolean | |
): string | undefined; | |
} | |
interface Boolean { | |
/** | |
* Calls the specified function block with `this` value as its argument and returns its result | |
* @param block - The function to be executed with `this` as argument | |
* @returns `block`'s result | |
*/ | |
let<R>(this: boolean | null | undefined, block: (it: boolean) => R): R; | |
/** | |
* Calls the specified function block with `this` value as its argument and returns `this` value | |
* @param block - The function to be executed with `this` as argument | |
* @returns `this` | |
*/ | |
also( | |
this: boolean | null | undefined, | |
block: (it: boolean) => void | |
): boolean; | |
/** | |
* Calls the specified function block with `this` value as its receiver and returns its value | |
* @param block - The function to be executed with `this` as context | |
* @returns `block`'s result | |
*/ | |
run<R>(this: boolean | null | undefined, block: (this: boolean) => R): R; | |
/** | |
* Calls the specified function block with `this` value as its receiver and returns `this` value | |
* @param block - The function to be executed with `this` as context | |
* @returns `this` | |
*/ | |
apply( | |
this: boolean | null | undefined, | |
block: (this: boolean) => void | |
): boolean; | |
/** | |
* Returns `this` value if it satisfies the given predicate or `undefined` if it doesn't | |
* @param predicate - The function to be executed with `this` as argument and returns a truthy or falsy value | |
* @returns `this` or `undefined` | |
*/ | |
takeIf( | |
this: boolean | null | undefined, | |
predicate?: (it: boolean) => boolean | |
): boolean | undefined; | |
/** | |
* Returns `this` value if it does not satisfy the given predicate or `undefined` if it does | |
* @param predicate - The function to be executed with `this` as argument and returns a truthy or falsy value | |
* @returns `this` or `undefined` | |
*/ | |
takeUnless( | |
this: boolean | null | undefined, | |
predicate?: (it: boolean) => boolean | |
): boolean | undefined; | |
} | |
} | |
Object.prototype.let = function (this, block) { | |
return block(this!); | |
}; | |
Object.prototype.also = function (this, block) { | |
block(this!); | |
return this!; | |
}; | |
Object.prototype.run = function (this, block) { | |
return block.call(this!); | |
}; | |
Object.prototype.apply = function (this, block) { | |
block.call(this!); | |
return this!; | |
}; | |
Object.prototype.takeIf = function (this, predicate) { | |
return predicate(this!) ? this! : undefined; | |
}; | |
Object.prototype.takeUnless = function (this, predicate) { | |
return predicate(this!) ? undefined : this!; | |
}; | |
Number.prototype.let = function (this, block) { | |
return block(this!.valueOf()); | |
}; | |
Number.prototype.also = function (this, block) { | |
block(this!.valueOf()); | |
return this!.valueOf(); | |
}; | |
Number.prototype.run = function (this, block) { | |
return block.call(this!.valueOf()); | |
}; | |
Number.prototype.apply = function (this, block) { | |
block.call(this!.valueOf()); | |
return this!.valueOf(); | |
}; | |
Number.prototype.takeIf = function (this, predicate) { | |
return predicate(this!.valueOf()) ? this!.valueOf() : undefined; | |
}; | |
Number.prototype.takeUnless = function (this, predicate) { | |
return predicate(this!.valueOf()) ? undefined : this!.valueOf(); | |
}; | |
String.prototype.let = function (this, block) { | |
return block(this!.valueOf()); | |
}; | |
String.prototype.also = function (this, block) { | |
block(this!.valueOf()); | |
return this!.valueOf(); | |
}; | |
String.prototype.run = function (this, block) { | |
return block.call(this!.valueOf()); | |
}; | |
String.prototype.apply = function (this, block) { | |
block.call(this!.valueOf()); | |
return this!.valueOf(); | |
}; | |
String.prototype.takeIf = function (this, predicate) { | |
return predicate(this!.valueOf()) ? this!.valueOf() : undefined; | |
}; | |
String.prototype.takeUnless = function (this, predicate) { | |
return predicate(this!.valueOf()) ? undefined : this!.valueOf(); | |
}; | |
Boolean.prototype.let = function (this, block) { | |
return block(this!.valueOf()); | |
}; | |
Boolean.prototype.also = function (this, block) { | |
block(this!.valueOf()); | |
return this!.valueOf(); | |
}; | |
Boolean.prototype.run = function (this, block) { | |
return block.call(this!.valueOf()); | |
}; | |
Boolean.prototype.apply = function (this, block) { | |
block.call(this!.valueOf()); | |
return this!.valueOf(); | |
}; | |
Boolean.prototype.takeIf = function (this, predicate) { | |
return (predicate && predicate(this!.valueOf())) || this!.valueOf() | |
? this!.valueOf() | |
: undefined; | |
}; | |
Boolean.prototype.takeUnless = function (this, predicate) { | |
return (predicate && predicate(this!.valueOf())) || this!.valueOf() | |
? undefined | |
: this!.valueOf(); | |
}; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment