docs: update docs

This commit is contained in:
Nolan Lawson 2020-06-12 08:08:57 -07:00
parent 0979086577
commit 55e6954de9
1 changed files with 34 additions and 1 deletions

View File

@ -374,6 +374,39 @@ Get the user's preferred skin tone. Returns 0 if not found.
___
#### getTopFavoriteEmoji
**getTopFavoriteEmoji**(`n`: number): *PromiseEmoji]*
Get the top favorite emoji in descending order. If there are no favorite emoji yet, returns an empty array.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`n` | number | maximum number of results to return |
**Returns:** *Promise[Emoji]*
___
#### incrementFavoriteEmojiCount
**incrementFavoriteEmojiCount**(`unicode`: string): *Promisevoid*
Increment the favorite count for an emoji by one. The unicode string must be non-empty. It should
correspond to the base (non-skin-tone) unicode string from the emoji object.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`unicode` | string | unicode of the emoji to increment |
**Returns:** *Promisevoid*
___
#### ready
**ready**(): *Promisevoid*
@ -390,7 +423,7 @@ ___
#### setPreferredSkinTone
**setPreferredSkinTone**(`skinTone`: SkinTone): *Promisevoid*
**setPreferredSkinTone**(`skinTone`: [SkinTone): *Promisevoid*
Set the user's preferred skin tone. Non-numbers throw an error.