Home Reference Source Repository
public class | source

Transformer

You can directly use instance of this class. transformer

Transforms an Item or Metadata by applying changes to it

Method Summary

Public Methods
public

transformItem(item: Item, changes: Changes, serializer: Serializer): Item

Transform an Item by applying changes to it

public

transformMetadata(metadata: Metadata, changes: Changes): Metadata

Transform Metadata by applying changes to it.

Public Methods

public transformItem(item: Item, changes: Changes, serializer: Serializer): Item source

Transform an Item by applying changes to it

Params:

NameTypeAttributeDescription
item Item

An item object

changes Changes

An array of changes

serializer Serializer

(Optional) A serializer to be used serializing default values

Return:

Item

The transformed item object

Example:

var item = {
  id: 1
};
var changes = [
  {
    change: 'column.create',
    projectId: '1',
    schemaId: '1',
    columnId: '2',
    column: {
      name: 'name',
      type: 'string',
      default: 'Anonymous'
    }
  }
];
transformer.transformItem(item, changes);
// {id: 1, name: 'Anonymous'}

public transformMetadata(metadata: Metadata, changes: Changes): Metadata source

Transform Metadata by applying changes to it.

Params:

NameTypeAttributeDescription
metadata Metadata

The metadata to transform

changes Changes

The changes to apply

Return:

Metadata

The transformed metadata