Class OperationFields

Operation fields containing application data.

Example

import { OperationFields, encodeOperation } from 'p2panda-js';

const fields = new OperationFields({
  name: 'Panda Party!',
});

fields.insert(
  'venue',
  'relation',
  '002078619bd4beff4bec4d4ccf75a7a5c25bf5d3c37fbd051a45debf1f17a1f75230'
);

const operation = encodeOperation({
  schemaId: 'events_00203ebb383f195f2923d51ac9929a8dbf7fba65dcddff874dfbe5ef131362696636',
  fields,
});

Hierarchy

  • OperationFields

Constructors

constructor

Methods

insert get length isEmpty

Constructors

constructor

  • Creates a new instance of OperationFields.

    Returns

    OperationFields instance

    Example

    import { OperationFields } from 'p2panda-js';

    const fields = new OperationFields({
      hasDate: true,
      latestYear: 2002,
    });

    Parameters

    • Optional fields: EasyValues

      "Easy field values" to populate the operation with basic data types. This can be used to easily create operation fields, even when there is no schema at hand. Please note that only unambigious field types like "str", "int", "float" and "bool" can be used here

    Returns OperationFields

Methods

insert

  • Inserts a new field.

    Example

    import { OperationFields } from 'p2panda-js';

    const fields = new OperationFields();
    fields.insert('venue', 'relation', '002078619bd4beff4bec4d4ccf75a7a5c25bf5d3c37fbd051a45debf1f17a1f75230');

    Parameters

    • fieldName: string

      Name of the field, needs to match schema

    • fieldType: FieldType

      Operation field type

    • value: OperationValueArg

      Actual user data

    Returns void

get

length

isEmpty

Settings

Member Visibility

Theme

Generated using TypeDoc