fix: MessageMedia interface to class (index.d.ts) (#301)

* fix: change MessageMedia to class

* fix: remove all references to MessageMediaInterface

* add MessageMedia constructor params docs
This commit is contained in:
stefanfuchs
2020-08-08 16:03:09 -03:00
committed by GitHub
parent fbdfd2c4dd
commit 97705b1865

26
index.d.ts vendored
View File

@@ -6,7 +6,7 @@ declare namespace WAWebJS {
export class Client extends EventEmitter { export class Client extends EventEmitter {
constructor(options: ClientOptions) constructor(options: ClientOptions)
/** Current connection information */ /** Current connection information */
public info: ClientInfo public info: ClientInfo
@@ -302,7 +302,7 @@ declare namespace WAWebJS {
/** whatsapp web url */ /** whatsapp web url */
export const WhatsWebURL: string export const WhatsWebURL: string
/** default client options */ /** default client options */
export const DefaultOptions: ClientOptions export const DefaultOptions: ClientOptions
@@ -513,12 +513,24 @@ declare namespace WAWebJS {
media?: MessageMedia media?: MessageMedia
} }
export interface MessageMedia { /** Media attached to a message */
data: string, export class MessageMedia {
mimetype: string, /** MIME type of the attachment */
filename?: string | null, mimetype: string
/** Base64-encoded data of the file */
data: string
/** Document file name. Value can be null */
filename?: string | null
fromFilePath: (filePath: string) => MessageMedia, /**
* @param {string} mimetype MIME type of the attachment
* @param {string} data Base64-encoded data of the file
* @param {?string} filename Document file name. Value can be null
*/
constructor(mimetype: string, data: string, filename?: string | null)
/** Creates a MessageMedia instance from a local file path */
static fromFilePath: (filePath: string) => MessageMedia
} }
export type MessageContent = string | MessageMedia | Location export type MessageContent = string | MessageMedia | Location