Skip to content

Commit 4c0d52d

Browse files
authored
Update README.md
1 parent 091f1d0 commit 4c0d52d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ A collection of readonly TypeScript types inspired by TypeScript's built-in read
1111

1212
The types here are all fully `Immutable` following [is-immutable-type#definitions](https://github.com/RebeccaStevens/is-immutable-type#definitions).
1313

14+
This package assumes you have TypeScript's [strict mode](https://www.typescriptlang.org/tsconfig#strict) and [noUncheckedIndexedAccess](https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess) option turned on. [eslint-plugin-total-functions](https://github.com/danielnixon/eslint-plugin-total-functions/) provides an ESLint rule to ensure they're both on.
15+
1416
## Installation
1517

1618
```sh
@@ -212,7 +214,7 @@ const result = foo.reduce((p) => p);
212214
| `PrincipledArray` ||||||
213215
| `PrincipledNonEmptyArray` ||||||
214216

215-
Assignments marked ⚠️ can lead to surprising mutation in whichever side of the assignment has "less" immutability. https://github.com/danielnixon/eslint-plugin-total-functions includes an ESLint rule to flag these unsafe assignments.
217+
Assignments marked ⚠️ can lead to surprising mutation in whichever side of the assignment has "less" immutability. [eslint-plugin-total-functions](https://github.com/danielnixon/eslint-plugin-total-functions/) includes an ESLint rule to flag these unsafe assignments.
216218

217219
## Purpose-built immutable data structures
218220

0 commit comments

Comments
 (0)