@ovotech/avro-epoch-days
v0.1.5
Published
A logical type representing Date as epoch days
Downloads
7,510
Maintainers
Keywords
Readme
Avro Epoch Days
A Logical type for representing a date stored as the number of days since epoch
Using
yarn add @ovotech/avro-epoch-days
And then you can use AvroEpochDays
for a logicalType of a field.
import { Type, Schema } from 'avsc';
import { AvroEpochDays } from '@ovotech/avro-epoch-days';
const eventSchema: Schema = {
type: 'record',
name: 'Event',
fields: [
{
name: 'field1',
type: { type: 'int', logicalType: 'date' },
},
],
};
const EventType = Type.forSchema(eventSchema, { logicalTypes: { date: AvroEpochDays } });
const encoded = EventType.toBuffer({ field1: new Date('2020-01-01') });
const decoded = EventType.fromBuffer(encoded);
console.log(decoded);
It also supports schema evolution from int, logical:date and string types
import { Type, Schema } from 'avsc';
import { AvroEpochDays } from '@ovotech/avro-epoch-days';
const previousSchema: Schema = {
type: 'record',
name: 'Event',
fields: [
{
name: 'field1',
type: { type: 'string' },
},
],
};
const eventSchema: Schema = {
type: 'record',
name: 'Event',
fields: [
{
name: 'field1',
type: { type: 'int', logicalType: 'date' },
},
],
};
const PreviousType = Type.forSchema(previousSchema);
const EventType = Type.forSchema(eventSchema, {
logicalTypes: { date: AvroEpochDays },
});
const previousTypeResolver = EventType.createResolver(PreviousType);
const encoded = PreviousType.toBuffer({ field1: '2020-01-01' });
const decoded = EventType.fromBuffer(encoded, previousTypeResolver);
console.log(decoded);
Running the tests
Then you can run the tests with:
yarn test
Coding style (linting, etc) tests
Style is maintained with prettier and tslint
yarn lint
Deployment
Deployment is preferment by lerna automatically on merge / push to main, but you'll need to bump the package version numbers yourself. Only updated packages with newer versions will be pushed to the npm registry.
Contributing
Have a bug? File an issue with a simple example that reproduces this so we can take a look & confirm.
Want to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see test folder).
License
This project is licensed under Apache 2 - see the LICENSE file for details