Module: userscript-utils/getUpdateMetablock

Methods

---

<static> fromFile(file, callback [, incUpdateURL] [, incDownloadURL])

Asynchronously extract the update metablock from the given file

Parameters:

Name	Type	Argument	Default	Description
file	string			Path to the file
callback	UserscriptUtilsErrStringCallback			The callback function
incUpdateURL	boolean	<optional>	false	Whether to include the @updateURL tag
incDownloadURL	boolean	<optional>	false	Whether to include the @downloadURL tag

Author:

• Art

Source:

• lib/get-update-metablock.js, line 98

---

<static> fromFileSync(file [, incUpdateURL] [, incDownloadURL])

Synchronously extract the update metablock from the given file

Parameters:

Name	Type	Argument	Default	Description
file	string			Path to the file
incUpdateURL	boolean	<optional>	false	Whether to include the @updateURL tag
incDownloadURL	boolean	<optional>	false	Whether to include the @downloadURL tag

Author:

• Art

Source:

• lib/get-update-metablock.js, line 87

Throws:

if the metadata block is not found

Type

Error

Returns:

The reduced metadata block suitable for .meta.js files

Type

string

---

<static> fromString(str, callback [, incUpdateURL] [, incDownloadURL])

Asynchronously extract the update metablock from the given string

Parameters:

Name	Type	Argument	Default	Description
str	string			The string to extract from
callback	UserscriptUtilsErrStringCallback			The callback function
incUpdateURL	boolean	<optional>	false	Whether to include the @updateURL tag
incDownloadURL	boolean	<optional>	false	Whether to include the @downloadURL tag

Author:

• Art

Source:

• lib/get-update-metablock.js, line 69

---

<static> fromStringSync(str [, incUpdateURL] [, incDownloadURL])

Synchronously extract the update metablock from the given string

Parameters:

Name	Type	Argument	Default	Description
str	string			The string to extract from
incUpdateURL	boolean	<optional>	false	Whether to include the @updateURL tag
incDownloadURL	boolean	<optional>	false	Whether to include the @downloadURL tag

Author:

• Art

Source:

• lib/get-update-metablock.js, line 32

Throws:

if the metadata block is not found

Type

Error

Returns:

The reduced metadata block suitable for .meta.js files

Type

string