Skip to main content

Function: createFrappeClient()

createFrappeClient<Docs>(options): FrappeClient<Docs>

Defined in: packages/client/src/client.ts:122

Creates a client for a single Frappe site.

Type Parameters​

Docs​

Docs extends object = object

Parameters​

options​

FrappeClientOptions

Returns​

FrappeClient<Docs>

Stable​

Example​

const frappe = createFrappeClient({
  url: 'https://frappe.example.com',
  auth: tokenAuth({ apiKey, apiSecret }),
})
const users = await frappe.db.getDocList('User', { fields: ['name', 'email'], limit: 20 })