export Class

Document

extends

File

implements

DocumentFilePacket

If there is no token set, it will get Token from your environment variables EnvironmentVariables .

Constructor

new Document( packet )

new Document( packet )

Parameter	Type	Description
packet	FilePacket	The packet metadata of the file.

new Document( file_id )

new Document( file_id )

Parameter	Type	Description
file_id	string	The id of the file.

new Document( path, options )

new Document( path, options )

Parameter	Type	Description
path	string	The absolute path to the file to attach.
options?	FormData.AppendOptions	Additional append options for uploading file, can be empty.

Properties

get form : [string, ReadStream, string | AppendOptions]

get id : string

get partial : boolean

file_id? : string

file_name? : string

file_path? : string

file_size? : number

file_unique_id? : string

mime_type? : string

options? : FormData.AppendOptions

path? : string

thumbnail? : PhotoSize

Methods

asyncdownload( path )

Parameter	Type	Description
path?	string	The absolute path to a file where you want to write the data.

Downloads the file, must have a token.

Returns: Promise<boolean | internal.Stream>

asyncfetch( )

Fetches the file, ensure that you have set the token or otherwise it will return the same instance.

Returns: Promise<Document>

parse( )

Returns the id of the file or the attach of the attached file.

Returns: string

setToken( token )

Parameter	Type	Description
token	string	The token to set, this is exclusive to this class.

Sets the token for fetching and downloading.

Returns: Document