summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/music/note.md
blob: 69447f33e81910c907115231169bcb328151e0eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# note

```js
// usage
chance.note();
chance.note({ notes: 'flatkey' });
```

Return a note. 🎵

```js
chance.note();
=> 'B'

chance.note();
=> 'E♭'
```

Options
flatKey - chromatic scale with flat notes (default)
sharpKey - chromatic scale with sharp notes
flats - just flat notes
sharps - just sharp notes
naturals - just natural notes
all - naturals, sharps and flats

```js
chance.note({notes: 'flats' });
=> 'A'

chance.note({notes: 'sharps' });
=> 'F♯'
```