Skip to main content

index

frappe-js-client — a zero-dependency, fetch-native TypeScript client for Frappe Framework REST APIs (v14, v15, v16).

This entry point is the core tier: client creation, auth, db, file, call, search. For permission, workflow, report, desk, and site, import from frappe-js-client/extended.

Example​

import { createFrappeClient, tokenAuth } from 'frappe-js-client'

const frappe = createFrappeClient({
  url: 'https://frappe.example.com',
  auth: tokenAuth({ apiKey: '...', apiSecret: '...' }),
})

const users = await frappe.db.getDocList('User', { fields: ['name', 'email'], limit: 20 })

Classes​

Interfaces​

Type Aliases​

Functions​

References​

FrappeRequest​

Re-exports FrappeRequest

FrappeResponse​

Re-exports FrappeResponse

Middleware​

Re-exports Middleware

NextFn​

Re-exports NextFn