Function getDoc

Retrieves a single document from the server based on the provided parameters.

This function performs an asynchronous request to the server to get a document of the specified doctype. It supports parameters for specifying the document's name, applying filters, and including a parent document.

// Retrieve a document of type 'Employee' with a specific name.
const params: getDocParams = {
  doctype: 'Employee',
  name: 'EMP-001',
};
const employee = await getDoc(params);
console.log(employee); // Logs the 'Employee' document with name 'EMP-001'
Copy

// Get a document of type 'Product' with a specific filter.
const params: getDocParams = {
  doctype: 'Product',
  filters: { status: 'Available' },
};
const product = await getDoc(params);
console.log(product); // Logs a 'Product' document that matches the filter
Copy

// Retrieve a document of type 'Order' with a parent document specified.
const params: getDocParams = {
  doctype: 'Order',
  parent: 'TASK-001',
};
const order = await getDoc(params);
console.log(order); // Logs the 'Order' document associated with parent 'TASK-001'
Copy

// Fetch a document of type 'Invoice' with both a specific name and filters applied.
const params: getDocParams = {
  doctype: 'Invoice',
  name: 'INV-123',
  filters: { status: 'Paid' },
};
const invoice = await getDoc(params);
console.log(invoice); // Logs the 'Invoice' document with name 'INV-123' and status 'Paid'
Copy