AugmentConfig

interface AugmentConfig<T extends generic>

An interface that defines the parameters for a call to the augment function.

Type parameters

• T: generic

Properties

end

end: undefined | AugmentParam <T, number>

An AugmentParam that describes how to compute the Annotation.end property.

id

id: undefined | AugmentParam <T, string>

An AugmentParam that describes how to compute the Annotation.id property.

objects

objects: T []

A list of type T, i.e. an arbitrary object representation of annotation records that fail to implement Annotation.

skipValidate

skipValidate: undefined | boolean

If this is set to true, this skips the validation on the returned objects. That means that the function will be happy to return objects that fail to implement Annotation.

start

start: undefined | AugmentParam <T, number>

An AugmentParam that describes how to compute the Annotation.start property.