Skip to content

Commit b281c64

Browse files
ST-DDTdemipel8
authored andcommitted
docs: update music jsdocs (faker-js#390)
1 parent 5fcda80 commit b281c64

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

src/music.ts

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import type { Faker } from '.';
22

3+
/**
4+
* Module to generate music related entries.
5+
*/
36
export class Music {
47
constructor(private readonly faker: Faker) {
58
// Bind `this` so namespaced is working correctly
@@ -9,19 +12,13 @@ export class Music {
912
}
1013
this[name] = this[name].bind(this);
1114
}
12-
13-
// TODO @Shinigami92 2022-01-12: We should find a better strategy as assigning this property to a function
14-
// @ts-expect-error
15-
this.genre.schema = {
16-
description: 'Generates a genre.',
17-
sampleResults: ['Rock', 'Metal', 'Pop'],
18-
};
1915
}
2016

2117
/**
22-
* genre
18+
* Returns a random music genre.
2319
*
24-
* @method faker.music.genre
20+
* @example
21+
* faker.music.genre() // 'Reggae'
2522
*/
2623
genre(): string {
2724
return this.faker.random.arrayElement(this.faker.definitions.music.genre);

0 commit comments

Comments
 (0)