Skip to content

Commit 89db2cd

Browse files
committed
Refact: use named functions for better doc support
1 parent baba488 commit 89db2cd

File tree

6 files changed

+15
-18
lines changed

6 files changed

+15
-18
lines changed

src/append.ts

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,14 @@
3535
* @param array Source array
3636
* @param items Extra items to append
3737
*/
38-
const append = <T>(
39-
array: readonly T[],
40-
...items: readonly T[]
41-
): readonly T[] => {
38+
function append<T>(array: readonly T[], ...items: readonly T[]): readonly T[] {
4239
if (items.length === 0) {
4340
return array;
4441
}
4542
if (array.length === 0) {
4643
return items;
4744
}
4845
return [...array, ...items];
49-
};
46+
}
5047

5148
export default append;

src/insert.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
* @param index Offset in `array` where to insert `items`
1919
* @param items Extra items to insert
2020
*/
21-
const insert = <T>(
21+
function insert<T>(
2222
array: readonly T[],
2323
index: number,
2424
...items: readonly T[]
25-
): readonly T[] => {
25+
): readonly T[] {
2626
if (index < 0 || index > array.length) {
2727
throw new RangeError(`index ${index} is our of range 0..${array.length}`);
2828
}
@@ -39,6 +39,6 @@ const insert = <T>(
3939
return [...array, ...items];
4040
}
4141
return [...array.slice(0, index), ...items, ...array.slice(index)];
42-
};
42+
}
4343

4444
export default insert;

src/remove.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919
* @param start Offset in `array` where to start
2020
* @param length Number of items to remove
2121
*/
22-
const remove = <T>(
22+
function remove<T>(
2323
array: readonly T[],
2424
start: number,
2525
length = 1,
26-
): readonly T[] => {
26+
): readonly T[] {
2727
if (start < 0 || start >= array.length) {
2828
throw new RangeError(
2929
`index ${start} is our of range 0..${array.length - 1}`,
@@ -42,6 +42,6 @@ const remove = <T>(
4242
return array.slice(0, start);
4343
}
4444
return [...array.slice(0, start), ...array.slice(start + length)];
45-
};
45+
}
4646

4747
export default remove;

src/set.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* @param index Offset to assign in
2323
* @param value New value to assign
2424
*/
25-
const set = <T>(array: readonly T[], index: number, value: T): readonly T[] => {
25+
function set<T>(array: readonly T[], index: number, value: T): readonly T[] {
2626
if (index < 0 || index >= array.length) {
2727
throw new RangeError(
2828
`index ${index} is our of range 0..${array.length - 1}`,
@@ -35,6 +35,6 @@ const set = <T>(array: readonly T[], index: number, value: T): readonly T[] => {
3535
const next = [...array];
3636
next[index] = value;
3737
return next;
38-
};
38+
}
3939

4040
export default set;

src/swap.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
* @param i Index 1
1919
* @param j Index 2
2020
*/
21-
const swap = <T>(array: readonly T[], i: number, j: number): readonly T[] => {
21+
function swap<T>(array: readonly T[], i: number, j: number): readonly T[] {
2222
if (i < 0 || i >= array.length) {
2323
throw new RangeError(
2424
`1st index ${i} is our of range 0..${array.length - 1}`,
@@ -37,6 +37,6 @@ const swap = <T>(array: readonly T[], i: number, j: number): readonly T[] => {
3737
const next = [...array];
3838
[next[i], next[j]] = [next[j], next[i]];
3939
return next;
40-
};
40+
}
4141

4242
export default swap;

src/update.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
* @param index Offset to update
1919
* @param updater Callback to calculate new value
2020
*/
21-
const update = <T>(
21+
function update<T>(
2222
array: readonly T[],
2323
index: number,
2424
updater: (prev: T, index: number) => T,
25-
): readonly T[] => {
25+
): readonly T[] {
2626
if (index < 0 || index >= array.length) {
2727
throw new RangeError(
2828
`index ${index} is our of range 0..${array.length - 1}`,
@@ -38,6 +38,6 @@ const update = <T>(
3838
const next = [...array];
3939
next[index] = newItem;
4040
return next;
41-
};
41+
}
4242

4343
export default update;

0 commit comments

Comments
 (0)