Class: BajoExtra

Constructor

new BajoExtra()

Constructor

Source: index.js, line 24

Members

config

Properties

Name Type Description

config

object

Configuration object

Properties

Name	Type	Description
`secret`	string	Secret key for encryption/decryption
`fetch`	object	Fetch configuration
`thumbnail`	object	Thumbnail configuration

Source: index.js, line 36

Methods

(async) countFileLines(file) → {Promise.<number>}

Count the number of lines in a file.

Parameters:

Name	Type	Description
`file`	string	The path to the file.

Source: index.js, line 182
See: StackOverflow

Returns:

The number of lines in the file.

Type:: Promise.<number>

(async) createThumbnail(file, optionsopt) → {Promise.<void>}

Create a thumbnail for a given image file.

Parameters:

Name Type Attributes Default Description

file

string

The path to the image file.

options

Object

{}

The options for creating the thumbnail.

Properties

Name	Type	Attributes	Default	Description
`dir`	string	<optional>		The directory to save the thumbnail. Defaults to the same directory as the file.
`silent`	boolean	<optional>	true	Whether to silently ignore errors. Defaults to true.
`size`	string \| Array.<string>	<optional>		The size(s) of the thumbnail. Defaults to the configured sizes.
`format`	string \| Array.<string>	<optional>		The format(s) of the thumbnail. Defaults to the configured output formats.
`opts`	Object	<optional>	{}	Additional options for the sharp library.

Source: index.js, line 656

Returns:

Type:: Promise.<void>

(async) decrypt(cipher, optionsopt) → {Promise.<string>}

Decrypt a given cipher using the specified decryption type and options.

Parameters:

Name Type Attributes Default Description

cipher

string

The cipher to be decrypted.

options

Object

{}

The decryption options.

Properties

Name	Type	Attributes	Default	Description
`type`	string	<optional>	'short'	The decryption type. Defaults to 'short'.
`subType`	string	<optional>	'qr'	The decryption sub-type. Defaults to 'qr'.

Source: index.js, line 592

Returns:

The decrypted text.

Type:: Promise.<string>

(async) download(url, opts, extra) → {Promise.<string>}

Download a file from a URL.

Parameters:

Name	Type	Description
`url`	string	The URL to download the file from.
`opts`	object	Fetch options.
`extra`	object	Extra options for downloading.

Source: index.js, line 212

Returns:

The path to the downloaded file.

Type:: Promise.<string>

(async) encrypt(text, optionsopt) → {Promise.<string>}

Encrypt a given text using the specified encryption type and options.

Parameters:

Name Type Attributes Default Description

text

string

The text to be encrypted.

options

Object

{}

The encryption options.

Properties

Name	Type	Attributes	Default	Description
`type`	string	<optional>	'short'	The encryption type. Defaults to 'short'.
`subType`	string	<optional>	'qr'	The encryption sub-type. Defaults to 'qr'.

Source: index.js, line 566

Returns:

The encrypted text.

Type:: Promise.<string>

(async) fetchAndSave(options)

Fetch data from a URL and save it using the specified options.

Parameters:

Name Type Description

options

object

The options for fetching and saving data.

Properties

Name	Type	Description
`url`	string	The URL to fetch data from.
`bulk`	object	Bulk operation options.
`save`	object	Save options.
`opts`	object	Fetch options.

Source: index.js, line 270

(async) fetchBulk(url, bulk, opts)

Fetch data from a URL in bulk, processing it in steps and applying a handler function to each item.

Parameters:

Name	Type	Description
`url`	string	The URL to fetch data from.
`bulk`	object	Bulk operation options.
`opts`	object	Fetch options.

Source: index.js, line 339

(async) fetchUrl(url, optsopt, extraopt) → {Promise.<Object>}

Download a file/resource from a URL.

Parameters:

Name Type Attributes Default Description

url

string

The URL to download the file from.

opts

object

{}

Fetch options. See Undici Client options for available options.

Properties

Name Type Attributes Default Description

method

object

'GET'

HTTP method to use for the request. Defaults to 'GET'.

auth

object

Basic authentication credentials.

Properties

Name	Type	Attributes	Description
`username`	string	<optional>	Username for basic authentication.
`password`	string	<optional>	Password for basic authentication.

query

object

Query parameters to append to the URL.

params

object

Alias for opts.query. Query parameters to append to the URL.

headers

object

HTTP headers to include in the request.

body

object

Request body to send with the request.

extra.formData

boolean

false

If true, sends the request body as multipart/form-data. Defaults to false.

extra

object

{}

Extra options for downloading.

Properties

Name	Type	Attributes	Default	Description
`cacheBuster`	boolean	<optional>	true	If true, appends a cache-busting query parameter to the URL. Defaults to `true`.
`cacheBusterKey`	string	<optional>	'_'	The query parameter key to use for cache-busting. Defaults to `'_'`.
`agent`	object	<optional>		Custom agent options for the fetch request. If provided, overrides the default agent configuration.
`rawResponse`	boolean	<optional>	false	If true, returns the raw response object instead of parsing it as JSON. Defaults to `false`.

Source: index.js, line 388

Returns:

The response object.

Type:: Promise.<Object>

formatByte(value, opts) → {string}

Format a value as bytes.

Parameters:

Name	Type	Description
`value`	number	The value to format.
`opts`	object	Formatting options.

Source: index.js, line 122

Returns:

Formatted byte string.

Type:: string

formatFloat(value, opts) → {string}

Format a value as a floating-point number.

Parameters:

Name	Type	Description
`value`	number	The value to format.
`opts`	object	Formatting options.

Source: index.js, line 138

Returns:

Formatted floating-point string.

Type:: string

formatInteger(value, opts) → {string}

Format a value as an integer.

Parameters:

Name	Type	Description
`value`	number	The value to format.
`opts`	object	Formatting options.

Source: index.js, line 152

Returns:

Formatted integer string.

Type:: string

formatPercentage(value, opts) → {string}

Format a value as a percentage.

Parameters:

Name	Type	Description
`value`	number	The value to format.
`opts`	object	Formatting options.

Source: index.js, line 166

Returns:

Formatted percentage string.

Type:: string

(async) gunzip(file, deleteOldopt) → {Promise.<void>}

Gunzip a file, optionally deleting the original file after extraction.

Parameters:

Name	Type	Attributes	Default	Description
`file`	string			The path to the file to be gunzipped.
`deleteOld`	boolean	<optional>	false	If true, deletes the original file after extraction. Defaults to false.

Source: index.js, line 453

Returns:

Resolves when the gunzip operation is complete.

Type:: Promise.<void>

(async) gzip(file, deleteOldopt, expandopt) → {Promise.<void>}

Gzip or gunzip a file, optionally deleting the original file after the operation.

Parameters:

Name	Type	Attributes	Default	Description
`file`	string			The path to the file to be gzipped or gunzipped.
`deleteOld`	boolean	<optional>	false	If true, deletes the original file after the operation. Defaults to `false`.
`expand`	boolean	<optional>	false	If true, gunzips the file. If false, gzips the file. Defaults to `false`.

Source: index.js, line 467

Returns:

Resolves when the gzip or gunzip operation is complete.

Type:: Promise.<void>

(async) hash(input, typeopt, optionsopt) → {Promise.<string>}

Hash a given text or object using the specified algorithm and options.

Parameters:

Name Type Attributes Default Description

input

string | object

The text or object to be hashed.

type

string

'md5'

The hashing algorithm to use. Defaults to 'md5'. Set to 'bcrypt' for bcrypt hashing or 'short' for a short hash.

options

object

{}

Additional options for the hashing algorithm.

Properties

Name	Type	Attributes	Default	Description
`digest`	string	<optional>	'hex'	The output encoding for the hash. Defaults to 'hex'.
`salt`	number	<optional>	10	The salt rounds for bcrypt hashing. Defaults to 10.

Source: index.js, line 496

Returns:

The resulting hash.

Type:: Promise.<string>

isBcrypt(text) → {boolean}

Check if a given text is a bcrypt hash.

Parameters:

Name	Type	Description
`text`	string	The text to be checked.

Source: index.js, line 517

Returns:

True if the text is a bcrypt hash, false otherwise.

Type:: boolean

isHtmlLink(text) → {boolean}

Check if a given text is an HTML link.

Parameters:

Name	Type	Description
`text`	string	The text to be checked.

Source: index.js, line 551

Returns:

True if the text is an HTML link, false otherwise.

Type:: boolean

isMd5(text) → {boolean}

Check if a given text is an MD5 hash.

Parameters:

Name	Type	Description
`text`	string	The text to be checked.

Source: index.js, line 529

Returns:

True if the text is an MD5 hash, false otherwise.

Type:: boolean

isSha256(text) → {boolean}

Check if a given text is a SHA-256 hash.

Parameters:

Name	Type	Description
`text`	string	The text to be checked.

Source: index.js, line 540

Returns:

True if the text is a SHA-256 hash, false otherwise.

Type:: boolean

randomRange(min, max, alphaopt) → {number|string}

Generate a random number or letter within a specified range.

Parameters:

Name	Type	Attributes	Default	Description
`min`	number			The minimum value of the range.
`max`	number			The maximum value of the range.
`alpha`	boolean	<optional>	false	Whether to return a letter instead of a number.

Source: index.js, line 616

Returns:

The generated random number or letter.

Type:: number | string

thumbnailSizes(name) → {Array.<number>}

Get the dimensions for a given thumbnail size name.

Parameters:

Name	Type	Description
`name`	string	The name of the thumbnail size (e.g., 's', 'm', 'l', or 'x').

Source: index.js, line 629

Returns:

The width and height of the thumbnail.

Type:: Array.<number>