Function bindMethodToSelf

bindMethodToSelf<S, A extends any[], B extends any[], R>(
    self: S,
    func: BindableFunction<S, A, B, R>,
    ...args: A,
): (...args: B) => R

binds a class-prototype-method func (by reference) to the passed object self (which should be an instance of the class), and returns that bound method.

Type Parameters

S
A extends any[]
B extends any[]
R

Parameters

self: S
the object to bind the method func to
func: BindableFunction<S, A, B, R>
the prototype-method to bind (by reference)
...args: A
partial tuple of the first few arguments that should be passed in by default

Returns (...args: B) => R

a version of the function func that is now bound to the object self, with the default first few partial arguments args

Example

type ID = number
const graph_edges = new Map<ID, Set<ID>>()
const set_graph_edge = bindMethodToSelf(graph_edges, graph_edges.set) // automatic type inference will correctly assign it the type: `(key: number, value: Set<number>) => Map<number, Set<number>>`
const edges: [ID, ID[]][] = [[1, [1,2,3]], [2, [3,5]], [3, [4, 7]], [4, [4,5]], [5, [7]]]
for (const [id, adjacent_ids] of edges) { set_graph_edge(id, new Set(adjacent_ids)) }

example with assigned default arguments

import { assertEquals } from "jsr:@std/assert"

const queue = [1, 2, 3, 7, 7, 7, 9, 9, 9]
const release_from_queue = bindMethodToSelf(queue, queue.splice, 0) // automatic type inference will correctly assign it the type: `(deleteCount: number, ...items: number[]) => number[]`
const test_arr: number[][] = []
while (queue.length > 0) { test_arr.push(release_from_queue(3)) }
assertEquals(test_arr, [
	[1, 2, 3],
	[7, 7, 7],
	[9, 9, 9],
])