Skip to main content

Function: createMetadataFor()

createMetadataFor\<T>(type, data): MetadataTypeMap[T]

Create a valid Metadata object.

Validates the input.

Type Parameters​

• T extends MetadataType

Parameters​

type​

T

The metadata type

data​

DataTypeMap[T]

The actual data for the generated metadata object

Returns​

MetadataTypeMap[T]

The version number of the metadata

Example​

import { createMetadataFor, MetadataType } from '@colony/event-metadata';

const result = createMetadataFor(MetadataType.Domain, {
  domainName: 'Cool team',
});

console.log(result.version); // 2
console.log(result.name); // 'domain'
console.log(result.data.domainName); // 'Cool team'