filterDocumentsByIds 🆕

Filter documents by ids. Case Insensitive.

Throws `errorNoCriteriaProvided` if props are empty.

Signature

MySQL

filterDocumentsByIds(session: MySQLSession, ids: Array<string>, pagination?: IOffsetPagination, sort?: Sort, filter?: FilterCriteria): Promise<IPaginatedSet<IDocument<S>>>;

MySQLX

filterDocumentsByIds(session: MySQLXSession, ids: Array<string>, pagination?: IOffsetPagination, sort?: Sort, filter?: FilterCriteria): Promise<IPaginatedSet<IDocument<S>>>;

Example

MySQL

// employeeRouter.{ts|js}
import { OffsetPagination, SortBy } from 'crud-node';
import { employeeController } from './employeeController';
import { EmployeeProps } from './schemas/employee';

const transacted = true;

await db.usingSession(async (session) => {
  const pagination = OffsetPagination(1, 10);
  const sort = SortBy().asc(EmployeeProps.places).toCriteria();
  const emplaoyeesIds = ['<id1>', '<id2>'];
  const data = await employeeController.filterDocumentsByIds(session, emplaoyeesIds, pagination, sort);
  return data;
}, transacted);

MySQLX

// employeeRouter.{ts|js}
import { OffsetPagination, SortBy } from 'crud-node';
import { employeeController } from './employeeController';
import { EmployeeProps } from './schemas/employee';

const transacted = true;

await db.usingSession(async (session) => {
  const pagination = OffsetPagination(1, 10);
  const sort = SortBy().asc(EmployeeProps.places).toCriteria();
  const emplaoyeesIds = ['<id1>', '<id2>'];
  const data = await employeeController.filterDocumentsByIds(session, emplaoyeesIds, pagination, sort);
  return data;
}, transacted);