filterDocuments 🆕

Filter documents by props. Case Sensitive.

Throws `errorNoCriteriaProvided` if props are empty.

Signature

MySQL

filterDocuments(session: MySQLSession, props: Partial<IDocument<S>>, join?: 'OR' | 'AND', pagination?: IOffsetPagination, sort?: Sort): Promise<IPaginatedSet<IDocument<S>>>;

MySQLX

filterDocuments(session: MySQLXSession, props: Partial<IDocument<S>>, join?: 'OR' | 'AND', pagination?: IOffsetPagination, sort?: Sort): Promise<IPaginatedSet<IDocument<S>>>;

Example

MySQL

// employeeRouter.{ts|js}
import { OffsetPagination } from 'crud-node';
import { employeeController } from './employeeController';

const transacted = true;

await db.usingSession(async (session) => {
  const pagination = OffsetPagination(1, 10);
  const data = await employeeController.filterDocuments(session, { fired: true }, 'AND', pagination);
  return data;
}, transacted);

MySQLX

// employeeRouter.{ts|js}
import { OffsetPagination } from 'crud-node';
import { employeeController } from './employeeController';

const transacted = true;

await db.usingSession(async (session) => {
  const pagination = OffsetPagination(1, 10);
  const data = await employeeController.filterDocuments(session, { fired: true }, 'AND', pagination);
  return data;
}, transacted);