Luxon Converter

Luxon based odata2ts compatible converters for date and time related OData types.

User facing data types:

• DateTime
• Duration

Conversions

OData Type	Result Type	Converter Id	Description
Edm.DateTimeOffset	DateTime	dateTimeOffsetToLuxonConverter
Edm.Date	DateTime	dateToLuxonConverter	Luxon's DateTime will still have the time part, which should be ignored by user
Edm.TimeOfDay	DateTime	timeOfDayToLuxonConverter	Luxon's DateTime will still have the date part, which should be ignored by user
Edm.Duration	Duration	durationToLuxonConverter

All result types are provided by Luxon.

Installation

npm

npm install --save @odata2ts/converter-luxon

Yarn

yarn add @odata2ts/converter-luxon

pnpm

pnpm add @odata2ts/converter-luxon

Luxon is declared as peer dependency.

info

This converter expects, that Luxon itself has been already installed, it doesn't pull Luxon automatically into your project. So if not already present, also install luxon.

Configuration

To integrate this converter into any odata2ts project, add it to the list of converters within the project configuration file odata2ts.config.ts. Converters are referenced by their package name, so in this case @odata2ts/converter-luxon.

For V2, the v2-to-v4-converter should also be installed to handle V2 date times (Edm.DateTime) with Luxon as well. For V4 you just leave it out.

import { ConfigOptions } from "@odata2ts/odata2ts";

const config: ConfigOptions = {
  converters: ["@odata2ts/converter-v2-to-v4", "@odata2ts/converter-luxon"],
};

export default config;

Select Converters

You can also choose to exactly specify which converters to use instead of automatically integrating all of them. Instead of a simple string you specify an object where the converters are listed by their id. These converter ids are listed in the conversions table.

    ...
    converters: [
      {
        module: "@odata2ts/converter-luxon",
        use: ["dateTimeOffsetToLuxonConverter", "durationToLuxonConverter"],
      },
    ],
    ...