Papier
Get started
FunctionSDK v0.2.1

createPapierClient

Factory function to create a type-safe Papier client.

Returns A fully initialized Papier client instance

import { createPapierClient } from '@usepapier/client/base';

Declaration #

base.tsTypeScript
export function createPapierClient<TProjects extends ProjectTemplates, P extends keyof TProjects, TPayloadMap extends Record<string, any> = Record<string, any>>(options: PapierOptions & {
    project: P;
}, projects: TProjects): Papier<TProjects, P, TPayloadMap>;

Source: packages/client/src/core/base.ts:250

Parameters

options
PapierOptions & { project: P }

Client configuration including project selection

projects
TProjects

Project definitions object

Examples #

Example from sourceTypeScript
const papier = createPapierClient({ project: "my-project" }, projects);
await papier.emails["welcome"].send({ to: "user@example.com", data: { name: "John" } });
Generated from TypeScript source.d65ea8f71fbf