Function: getBoardProperty()

function getBoardProperty(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Defined in: src/server/api/board.ts:319

Returns the value of the property with a given key from the board identified by the provided id. The user who retrieves the property is required to have permissions to view the board.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ boardId: number; propertyKey: string; }	-
parameters.boardId	number	The id of the board from which the property will be returned.
parameters.propertyKey?	string	The key of the property to return.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>