Skip to content

Commit b2f539e

Browse files
committed
docs(array): add docs for make, fromInitializer, findMap and keepSome
1 parent 8eb7433 commit b2f539e

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

src/Core__Array.resi

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,29 @@
55
external fromArrayLikeWithMap: (Js.Array2.array_like<'a>, 'a => 'b) => array<'b> = "Array.from"
66
@val external fromIterator: Core__Iterator.t<'a> => array<'a> = "Array.from"
77
@val external fromIteratorWithMap: (Core__Iterator.t<'a>, 'a => 'b) => array<'b> = "Array.from"
8+
9+
/**
10+
`make(~length, init)`
11+
12+
Creates an array of length `length` initialized with the value of `init`.
13+
14+
```res example
15+
Array.make(~length=3, #apple) == [#apple, #apple, #apple]
16+
```
17+
*/
818
let make: (~length: int, 'a) => array<'a>
19+
20+
/**
21+
`fromInitializer(~length, f)`
22+
23+
Creates an array of length `length` initialized with the value returned from `f ` for each index.
24+
25+
```res example
26+
Array.make(~length=3, i => i + 3) == [3, 4, 5]
27+
```
28+
*/
929
let fromInitializer: (~length: int, int => 'a) => array<'a>
30+
1031
@val external isArray: 'a => bool = "Array.isArray"
1132
@get external length: array<'a> => int = "length"
1233
@send external copyAllWithin: (array<'a>, ~target: int) => array<'a> = "copyWithin"
@@ -120,10 +141,31 @@ external setUnsafe: (array<'a>, int, 'a) => unit = "%array_unsafe_set"
120141
let findIndexOpt: (array<'a>, 'a => bool) => option<int>
121142
let reverse: array<'a> => array<'a>
122143
let filterMap: (array<'a>, 'a => option<'b>) => array<'b>
144+
145+
/**
146+
`fromInitializer(~length, f)`
147+
148+
Creates an array of length `length` initialized with the value returned from `f ` for each index.
149+
150+
```res example
151+
Array.make(~length=3, i => i + 3) == [3, 4, 5]
152+
```
153+
*/
123154
let keepSome: array<option<'a>> => array<'a>
124155
let shuffle: array<'a> => array<'a>
125156
let shuffleInPlace: array<'a> => unit
126157
@send external flatMap: (array<'a>, 'a => array<'b>) => array<'b> = "flatMap"
158+
159+
/**
160+
`findMap(arr, f)`
161+
162+
Calls `f` for each element and returns the first value from `f` that is `Some(_)`.
163+
Otherwise returns `None`
164+
165+
```res example
166+
Array.findMap([1, 2, 3], n => mod(n, 2) ? Some(n - 2) : None) == 0
167+
```
168+
*/
127169
let findMap: (array<'a>, 'a => option<'b>) => option<'b>
128170

129171
/**

0 commit comments

Comments
 (0)