microdata-tooling

Index

Classes

Interfaces

Type aliases

Thing

Functions

Type aliases

Thing

Thing: ThingBase | string

Functions

apply

apply(data: Thing, element: HTMLElement, options?: ApplyOptions): void

- Defined in apply.ts:87
Apply micro data to an HTML element tree.

remarks

Generally, if a value is a string it will be set as the text for an element and if an object it will recurse on the properties. To support values that are an array, HTMLTemplateElements are used. Each item in the array looks for a template with an attribute data-type that matches the type. Strings look for a type of Text.

see

https://html.spec.whatwg.org/multipage/microdata.html

Parameters
- data: Thing
  
  The micro data to apply.
- element: HTMLElement
  
  The root of the HTML element tree.
- options: ApplyOptions = {}
  
  Optional options for applying data.
Returns void

jsonify

jsonify(nodes: Element[]): MicroJson

- Defined in jsonify.ts:28
Read micro data from a HTML element tree as specified in the standard.

remarks

Unlike with the spec, the returned value is an object model, not a JSON string.

see

https://html.spec.whatwg.org/multipage/microdata.html#json

Parameters
- nodes: Element[]
  
  The elements to extract from.
Returns MicroJson

Extracted micro data.

parse

parse(element: HTMLElement, options?: ParseOptions): Thing[]

- Defined in parse.ts:37
Read micro data from an HTML element tree.

throws

NoTypeError

An item has no type.

throws

MultiTypeError

An item has more than one type.

see

https://html.spec.whatwg.org/multipage/microdata.html

Parameters
- element: HTMLElement
  
  The root of the HTML element tree.
- options: ParseOptions = {}
  
  The options for parsing the tree.
Returns Thing[]

The parsed micro data.

Generated using TypeDoc