Board

A monday.com board.

Properties#

columns: Array<Column>#

The board's columns.

description: string#

The board's description.

groups: Array<Group>#

The board's columns.

id: string#

The unique identifier of the board.

name: string#

The board's name.

Methods#

createColumn#

createColumn(title, type): Promise<Column>

Parameters:#

NameType
titlestring
typeColumnTypes

Returns: Promise<Column>

createGroup#

createGroup(title): Promise<Group>

Parameters:#

NameType
titlestring

Returns: Promise<Group>

createItem#

createItem(name, values, groupNameOrId): Promise<Item>

Create new item in board

Parameters:#

NameTypeDescriptionOptional
namestringItem name-
valuesanyItem values object with colum name or idYes
groupNameOrIdanygroup name or idYes

Returns: Promise<Item>

getColumn#

getColumn(idOrTitle): Column

Parameters:#

NameType
idOrTitlekeyof any

Returns: Column

getGroup#

getGroup(idOrTitle): Group

Parameters:#

NameType
idOrTitleany

Returns: Group

getItems#

getItems(): Promise<Array<Item>>

Get board items

Returns: Promise<Array<Item>>