Function getSingleValue

Retrieves a single value from a specific field in a document of the given doctype.

This function performs an asynchronous request to the server to get the value of a specific field from a document of the specified doctype. It is designed for cases where only a single field's value is needed, without the need for additional filtering or complex queries.

// Retrieve the value of the 'company_name' field from a document of type 'Company'.
const params: getSingleValueParams = {
  doctype: 'Company',
  field: 'company_name',
};
const companyName = await getSingleValue(params);
console.log(companyName); // Logs the value of the 'company_name' field
Copy

// Get the value of the 'tax_rate' field from a 'Settings' document.
const params: getSingleValueParams = {
  doctype: 'Settings',
  field: 'tax_rate',
};
const taxRate = await getSingleValue(params);
console.log(taxRate); // Logs the value of the 'tax_rate' field
Copy

// Fetch the 'currency_symbol' field value from the 'Currency' doctype.
const params: getSingleValueParams = {
  doctype: 'Currency',
  field: 'currency_symbol',
};
const currencySymbol = await getSingleValue(params);
console.log(currencySymbol); // Logs the value of the 'currency_symbol' field
Copy