planning-center-monorepo / planning-center-base-ts/src / buildIncludeParams

Function: buildIncludeParams()

buildIncludeParams(include?): Record<string, string | undefined>

Defined in: packages/planning-center-base-ts/src/query-params.ts:90

Build simple query params for include-only requests (like getById)

Parameters

include?

string[]

Array of resource types to include

Returns

Record<string, string | undefined>

Object with include parameter, or empty object if no includes

Example


const params = buildIncludeParams(['emails', 'phone_numbers']);
// Returns: { include: 'emails,phone_numbers' }
 
const emptyParams = buildIncludeParams();
// Returns: {}