summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/music
diff options
context:
space:
mode:
Diffstat (limited to 'src/node_modules/chance/docs/music')
-rw-r--r--src/node_modules/chance/docs/music/note.md33
-rw-r--r--src/node_modules/chance/docs/music/tempo.md24
2 files changed, 57 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/music/note.md b/src/node_modules/chance/docs/music/note.md
new file mode 100644
index 0000000..69447f3
--- /dev/null
+++ b/src/node_modules/chance/docs/music/note.md
@@ -0,0 +1,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♯'
+```
diff --git a/src/node_modules/chance/docs/music/tempo.md b/src/node_modules/chance/docs/music/tempo.md
new file mode 100644
index 0000000..8e0cc27
--- /dev/null
+++ b/src/node_modules/chance/docs/music/tempo.md
@@ -0,0 +1,24 @@
+# tempo
+
+```js
+// usage
+chance.tempo(); //default between 40 to 320
+chance.tempo({ min: 60, max: 120 });
+```
+
+Return a tempo. 🎵
+
+```js
+chance.tempo();
+=> 58
+
+chance.tempo();
+=> 281
+
+chance.tempo({ max: 80 });
+=> 45
+
+chance.tempo({ min: 120 });
+=> 172
+
+``` \ No newline at end of file