@e2y/odata-client

odata-client

This package wraps the amazing npm package o.js adding the extra functionality to run cronjobs.

Usage

import { ODataClient } from '@e2y/odata-client';

const odata = ODataClient.configuredWith({
  baseURL: 'https://localhost:9002/odata2webservices/',
  password: '*****',
  username: 'admin'
});

const order = ((await odata.handler.get(ODATA_ENDPOINTS.orders).query({
  $expand: 'paymentTransactions/entries',
  $filter: `code eq '123'`,
  $format: 'json'
})) as unknown) as IODataGetResponse<IOrder>;

In order to create your own tasks, use the handler defined in the odata instance. Check the o.js documentation to improve your queries. Also, it is possible to cast the responses using your own types with IODataGetResponse<T>.

To run a cronjob, we need to complete the configuration adding the attributes defined in cronjob. The attribute prePersistenceHookBeanId is mandatory. While the attribute endpoint can be empty. In that case, it will point to InboundCronJobs/CronJobs by default.

After configuring it properly. We just need to run the following command:

await odata.runCronjob('fullMiraklImportShopsOffersCompositeCronJob');

Thanks

Special thanks to janhommes for his amazing work.