@elastic/ecs

@elastic/ecs

Automatically generated TypeScript type definitions for the Elastic Common Schema.

When run, this program will fetch the ECS schema from the elastic/ecs repository. Defaults to main ref, can be overridden with --ref flag.

Local development

• Install yarn & Node.js
• yarn build: Runs tsc
• yarn dev: Runs tsc and watches for changes
• yarn test: Runs unit tests with jest
• yarn generate-ecs-types: Generates a ts file in generated/ecs.ts

Entrypoints

@elastic/ecs only exports ecs-based type definitions and an EcsVersion constant.

@elatic/ecs/extended contains both type definitions and the EcsFlat object, that contains the entire schema parsed as object literal. This can be used for advanced validation scenarios.