The value of the first node in the linked list, or undefined if the linked list is empty.
The head function returns the first node of a singly linked list.
The method is returning either a SinglyLinkedListNode object or undefined.
The function returns the value of the last element in a linked list, or undefined if the list is empty.
The value of the last node in the linked list, or undefined if the linked list is empty.
The function returns the size of an object.
The size of the object, which is a number.
The tail function returns the last node of a singly linked list.
The method is returning either a SinglyLinkedListNode object or undefined.
The function returns the _toElementFn property, which is a function that converts a raw element to a specific type.
The function get toElementFn() is returning either a function that takes a raw element
rawElement of type R and returns an element E, or undefined if no function is assigned to
_toElementFn.
Time Complexity: O(n) Space Complexity: O(1)
The function is an implementation of the Symbol.iterator method that returns an IterableIterator.
Rest ...args: any[]The args parameter in the code snippet represents a rest parameter. It
allows the function to accept any number of arguments as an array. In this case, the args
parameter is used to pass any number of arguments to the _getIterator method.
Protected _getTime Complexity: O(n) Space Complexity: O(1)
The addAfter function inserts a new node with a given value after an existing node in a singly linked list.
The existing value or node in the linked list after which the new value will be inserted. It can be either the value of the existing node or the existing node itself.
The value that you want to insert into the linked list after the existing value or node.
The method returns a boolean value. It returns true if the new value was successfully inserted after the existing value or node, and false if the existing value or node was not found in the linked list.
Time Complexity: O(n) Space Complexity: O(1)
The addAt function inserts a value at a specified index in a singly linked list.
The index parameter represents the position at which the new value should be inserted in the linked list. It is of type number.
The value parameter represents the value that you want to insert into the linked list at the
specified index.
The insert method returns a boolean value. It returns true if the insertion is successful, and false
if the index is out of bounds.
Time Complexity: O(n) Space Complexity: O(1)
The addBefore function inserts a new value before an existing value in a singly linked list.
The existing value or node that you want to insert the new value before. It can be either the value itself or a node containing the value in the linked list.
The newValue parameter represents the value that you want to insert into the linked list.
The method addBefore returns a boolean value. It returns true if the new value was successfully
inserted before the existing value, and false otherwise.
Time Complexity: O(n) Space Complexity: O(1)
The function at returns the value at a specified index in a linked list, or undefined if the index is out of range.
The index parameter is a number that represents the position of the element we want to retrieve from the list.
The method at(index: number): E | undefined returns the value at the specified index in the linked list, or
undefined if the index is out of bounds.
Time Complexity: O(n) Space Complexity: O(n)
The clone function returns a new instance of the SinglyLinkedList class with the same values
as the original list.
The clone() method is returning a new instance of the SinglyLinkedList class, which
is a clone of the original list.
Time Complexity: O(n) Space Complexity: O(1)
The function counts the number of occurrences of a given value in a linked list.
The value parameter is the value that you want to count the occurrences of in the linked list.
The count of occurrences of the given value in the linked list.
Time Complexity: O(n) Space Complexity: O(1)
The delete function removes a node with a specific value from a singly linked list.
The valueOrNode parameter can accept either a value of type E
or a SinglyLinkedListNode<E> object.
The delete method returns a boolean value. It returns true if the value or node is found and
successfully deleted from the linked list, and false if the value or node is not found in the linked list.
Time Complexity: O(n) Space Complexity: O(1)
The deleteAt function removes an element at a specified index from a linked list and returns the removed element.
The index parameter represents the position of the element that needs to be deleted in the data structure. It is of type number.
The method deleteAt returns the value of the node that was deleted, or undefined if the index is out of
bounds.
Time Complexity: O(n) Space Complexity: O(1)
The every function checks if every element in the array satisfies a given predicate.
The predicate parameter is a callback function that takes three arguments:
the current element being processed, its index, and the array it belongs to. It should return a
boolean value indicating whether the element satisfies a certain condition or not.
Optional thisArg: anyThe thisArg parameter is an optional argument that specifies the value
to be used as this when executing the predicate function. If thisArg is provided, it will be
passed as the this value to the predicate function. If thisArg is
The every method is returning a boolean value. It returns true if every element in
the array satisfies the provided predicate function, and false otherwise.
Time Complexity: O(n) Space Complexity: O(n)
The filter function creates a new SinglyLinkedList by iterating over the elements of the current
list and applying a callback function to each element to determine if it should be included in the
filtered list.
The callback parameter is a function that will be called for each element in the list. It takes three arguments: the current element, the index of the current element, and the list itself. The callback function should return a boolean value indicating whether the current element should be included in the filtered list or not
Optional thisArg: anyThe thisArg parameter is an optional argument that specifies the value
to be used as this when executing the callback function. If thisArg is provided, it will be
passed as the this value to the callback function. If thisArg is
The filter method is returning a new SinglyLinkedList object that contains the
elements that pass the filter condition specified by the callback function.
Time Complexity: O(n) Space Complexity: O(1)
The find function iterates over the elements of an array-like object and returns the first
element that satisfies the provided callback function.
The callbackfn parameter is a function that will be called for each element in the array. It takes three arguments: the current element being processed, the index of the current element, and the array itself. The function should return a boolean value indicating whether the current element matches the desired condition.
Optional thisArg: anyThe thisArg parameter is an optional argument that specifies the value
to be used as this when executing the callbackfn function. If thisArg is provided, it will
be passed as the this value to the callbackfn function. If thisArg @returns The findmethod returns the first element in the array that satisfies the provided callback function. If no element satisfies the callback function,undefined` is returned.
Time Complexity: O(n) Space Complexity: O(1)
The forEach function iterates over each element in an array-like object and calls a callback
function for each element.
The callbackfn parameter is a function that will be called for each element in the array. It takes three arguments: the current element being processed, the index of the current element, and the array that forEach was called upon.
Optional thisArg: anyThe thisArg parameter is an optional argument that specifies the value
to be used as this when executing the callbackfn function. If thisArg is provided, it will
be passed as the this value to the callbackfn function. If `thisArg
Time Complexity: O(n) Space Complexity: O(1)
The function finds a node in a singly linked list by its value and returns the node if found, otherwise returns undefined.
The value parameter is the value that we want to search for in the linked list.
a SinglyLinkedListNode<E> if a node with the specified value is found in the linked list. If no node with
the specified value is found, the function returns undefined.
Time Complexity: O(n) Space Complexity: O(1)
The function getNodeAt returns the node at a given index in a singly linked list.
The index parameter is a number that represents the position of the node we want to
retrieve from the linked list. It indicates the zero-based index of the node we want to access.
The method getNodeAt(index: number) returns a SinglyLinkedListNode<E> object if the node at the
specified index exists, or undefined if the index is out of bounds.
Time Complexity: O(n) Space Complexity: O(1)
The function checks if a given element exists in a collection.
The parameter "element" is of type E, which means it can be any type. It represents the element that we want to check for existence in the collection.
a boolean value. It returns true if the element is found in the collection, and false otherwise.
Time Complexity: O(n) Space Complexity: O(1)
The indexOf function returns the index of the first occurrence of a given value in a linked list.
The value parameter is the value that you want to find the index of in the linked list.
The method is returning the index of the first occurrence of the specified value in the linked list. If the value is not found, it returns -1.
The map function takes a callback function and returns a new SinglyLinkedList with the results
of applying the callback to each element in the original list.
The callback parameter is a function that will be called for each element in
the original list. It takes three arguments: current (the current element being processed),
index (the index of the current element), and this (the original list). It should return a
value
Optional toElementFn: ((rawElement) => EM)The toElementFn parameter is an optional function that can be used to
convert the raw element (RR) to the desired element type (T). It takes the raw element as
input and returns the converted element. If this parameter is not provided, the raw element will
be used as is.
Optional thisArg: anyThe thisArg parameter is an optional argument that allows you to
specify the value of this within the callback function. It is used to set the context or scope
in which the callback function will be executed. If thisArg is provided, it will be used as the
value of
a new instance of the SinglyLinkedList class with the mapped elements.
Time Complexity: O(1) Space Complexity: O(1)
The push function adds a new element to the end of a singly linked list.
The "element" parameter represents the value of the element that you want to add to the linked list.
The push method is returning a boolean value, true.
Time Complexity: O(n) Space Complexity: O(1)
The reduce function iterates over the elements of an array-like object and applies a callback
function to reduce them into a single value.
The callbackfn parameter is a function that will be called for each element in the array. It takes four arguments:
The initialValue parameter is the initial value of the accumulator. It is the value that the accumulator starts with before the reduction operation begins.
The reduce method is returning the final value of the accumulator after iterating over
all the elements in the array and applying the callback function to each element.
Time Complexity: O(n) Space Complexity: O(1)
The reverse function reverses the order of the nodes in a singly linked list.
The reverse() method does not return anything. It has a return type of void.
Time Complexity: O(n) Space Complexity: O(1)
The "some" function checks if at least one element in a collection satisfies a given predicate.
The predicate parameter is a callback function that takes three arguments:
value, index, and array. It should return a boolean value indicating whether the current
element satisfies the condition.
Optional thisArg: anyThe thisArg parameter is an optional argument that specifies the value
to be used as the this value when executing the predicate function. If thisArg is provided,
it will be passed as the this value to the predicate function. If `thisArg
a boolean value. It returns true if the predicate function returns true for any element in the collection, and false otherwise.
Time Complexity: O(1) Space Complexity: O(1)
The unshift function adds a new element to the beginning of a singly linked list.
The "element" parameter represents the value of the element that you want to add to the beginning of the singly linked list.
The unshift method is returning a boolean value, true.
Static fromTime Complexity: O(n) Space Complexity: O(n)
The fromArray function creates a new SinglyLinkedList instance and populates it with the elements from the given
array.
The data parameter is an array of elements of type E.
The fromArray function returns a SinglyLinkedList object.
Generated using TypeDoc
The above function returns the value of the first element in a linked list, or undefined if the list is empty.