Skip to content

Function: starBoard()

ts
function starBoard(client, parameters): Promise<{
  id: string;
  idBoard?: string;
  pos?: number;
}>;

Defined in: api/members.ts:251

Star a new board on behalf of a Member

Parameters

ParameterTypeDescription
clientClient-
parameters{ id: string; idBoard: string; pos: string | number; }-
parameters.idstringThe ID or username of the member
parameters.idBoardstringThe ID of the board to star
parameters.posstring | numberThe position of the newly starred board. top, bottom, or a positive float.

Returns

Promise<{ id: string; idBoard?: string; pos?: number; }>