Reference

info

Parameter names are slightly different between JavaScript and Python. Python names require snake_case but are documented with camelCase.

Functions

boardList() ⇒ Object

Retrieves all available boards.

boardRegister(board, name, cache, versions) ⇒ String

Registers a board, useful to find resources with pinFind() or pin to additional boards with pin().

pinGet(name, board, cache, extract, version, files, signature) ⇒ Object

Retrieves a pin by name and, by default, from the local board. You can use the board parameter to specify which board to retrieve a pin from. If a board is not specified, it will use pinFind() to find the pin across all boards and retrieve the one that matches by name.

pinRemove(name, board)

Removes a pin by name from the local or given board.

pinFind(text, board, name, extended)

Find a pin in any board registered.

boardList() ⇒ Object

Retrieves all available boards.

Kind: global function
Returns: Object - All the names from the registered boards.
Example

• JavaScript
• Python

pins.boardList();

boardRegister(board, name, cache, versions) ⇒ String

Registers a board, useful to find resources with pinFind() or pin to additional boards with pin().

Kind: global function
Returns: String - The name of the board.

Param	Type	Description
board	String	The name of the board to register.
name	String	An optional name to identify this board, defaults to the board name.
cache	String	The local folder to use as a cache.
versions	Boolean	Should this board be registered with support for versions?

Example

• JavaScript
• Python

pins.boardRegister("s3", {

bucket: "bucket",

key: "key",

secret: "secret"

});

pinGet(name, board, cache, extract, version, files, signature) ⇒ Object

Retrieves a pin by name and, by default, from the local board. You can use the board parameter to specify which board to retrieve a pin from. If a board is not specified, it will use pinFind() to find the pin across all boards and retrieve the one that matches by name.

Kind: global function
Returns: Object - A pin from a given board.

Param	Type	Description
name	String	The name of the pin.
board	String	The board where this pin will be retrieved from.
cache	Boolean	Should the pin cache be used? Defaults to true.
extract	Boolean	Should compressed files be extracted? Each board defines the default behavior.
version	String	The version of the dataset to retrieve, defaults to latest one.
files	Boolean	Should only the file names be returned? Defaults to false.
signature	String	Optional signature to validate this pin, use pin_info() to compute signature.

Example

• JavaScript
• Python

pins.pinGet("numbers")

pinRemove(name, board)

Removes a pin by name from the local or given board.

Kind: global function

Param	Type	Description
name	String	The name of the pin.
board	Object	The board where this pin will be retrieved from.

Example

• JavaScript
• Python

pins.pinRemove("numbers", { board: 'local' })

pinFind(text, board, name, extended)

Find a pin in any board registered.

Kind: global function

Param	Type	Description
text	String	The text to find in the pin description or name.
board	String	The board where this pin will be retrieved from.
name	String	The exact name of the pin to match when searching.
extended	Boolean	Should additional board-specific columns be shown?

Example

• JavaScript
• Python

pins.pinFind("")