simple-squiggle/node_modules/mathjs/docs/reference/functions/help.md

755 B

Function help

Retrieve help on a function or data type. Help files are retrieved from the embedded documentation in math.docs.

Syntax

math.help(search)

Parameters

Parameter Type Description
search Function | string | Object A function or function name for which to get help

Returns

Type Description
Help A help object

Throws

Type Description

Examples

console.log(math.help('sin').toString())
console.log(math.help(math.add).toString())
console.log(math.help(math.add).toJSON())