0.2.2 • Published 8 months ago

@odata2ts/converter-ui5-v2 v0.2.2

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

npm (scoped)

UI5 ODataModel V2 Converters

Converter package for interoperability between odata2ts and SAP's V2 ODataModel (sap.ui.model.odata.v2.ODataModel).

The ODataModel is not only responsible for the REST communication, but also takes care of data type conversion. This converter package supplies odata2ts with all converters needed to use the same types as the ODataModel does.

This way you get the correct types, when generating model types which represent sap.ui.model.odata.v2.ODataModel values. On the other hand, it also allows you to use the generated OData client in combination with the ODataModel.

Conversions

This package adds only one special converter for converting Edm.Time to a custom object which holds the milliseconds since midnight. All other converters are imported from other packages:

  • converter-v2-to-v4
  • converter-common
OData TypeJSON Rep.FormatData TypeUses
Edm.DateTimestring/Date(timestamp)/DatedateTimeToDateTimeOffsetConverterdateTimeOffsetToDateConverter
Edm.DateTimeOffsetstringISO 8601 Date and Timewith offsetsDatedateTimeOffsetToDateConverter
Edm.TimestringISO 8601 Duration(limited to the time part){ ms: number }timeToMsDurationConverter
Edm.BytestringnumberstringToNumberConverter
Edm.SBytestringnumberstringToNumberConverter
Edm.SinglestringnumberstringToNumberConverter
Edm.DoublestringnumberstringToNumberConverter

Installation

npm install --save @odata2ts/converter-ui5-v2

Documentation

Common Converter Documentation

Main Documentation of odata2ts: https://odata2ts.github.io/

Support, Feedback, Contributing

This project is open to feature requests, suggestions, bug reports, usage questions etc. via GitHub issues.

Contributions and feedback are encouraged and always welcome.

See the contribution guidelines for further information.

Spirit

This project has been created and is maintained in the following spirit:

  • adhere to the OData specification as much as possible
    • support any OData service implementation which conforms to the spec
    • allow to work around faulty implementations if possible
  • stability matters
    • exercise Test Driven Development
    • bomb the place with unit tests (code coverage > 95%)
    • ensure that assumptions & understanding are correct by creating integration tests

License

MIT - see License.