Skip to content

Function: starBoard()

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

Defined in: api/members.ts:283

Star a new board on behalf of a Member

Parameters

ParameterTypeDescription
clientClient-
parameters{ id: string; idBoard: string; pos: string | number | string & object; }-
parameters.idstringThe ID or username of the member
parameters.idBoard?stringThe ID of the board to star
parameters.pos?string | number | string & objectThe position of the newly starred board. top, bottom, or a positive float.
options?RequestOptions-

Returns

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