Documentation

Extensions Reference: DynamicValue
- DynamicValue

Extensions Reference: DynamicValue¶

API Reference
DynamicValue

DynamicString
Request

DynamicValue

DynamicValue¶

Represents a dynamic value that can be inserted in a dynamic string. A dynamic value is a smart item that you can insert anywhere in strings (headers, URL params, body, environment variables) inside the requests you create with Paw, it can do dynamic computation (some are natively bundled in the app, others can be added via extensions) or simply return the value of an environment variable.

DynamicValue

DynamicValue¶

Argument: identifier: string: None
A the dynamic value identifier, for native dynamic values it can be found in the documentation, for dynamic values installed via extensions this depends on the developer

Argument: properties: Object: ``{}``

an object containing the properties of the dynamic value

{}

The constructor DynamicValue() is globally available in Paw. It takes at least one argument, and up to two.

function import(context, items, options) {

  // create a new request
  var request = context.createRequest("Users", "GET", "http://api.example.com/users");

  // create a dynamic value
  var dynamicValue = DynamicValue('com.luckymarmot.PawExtensions.RegexDynamicValue', {
        'input':'support@paw.cloud',
        'regex':'([\w\-\_\.]+)\@[\w\-\_\.]+\.\w+',
        'replacement':'\1'
  });

  // set the dynamic value in the request header
  request.setHeader("X-Login", DynamicString(dynamicValue));
}

type

type¶

The dynamic value identifier.

function import(context, items, options) {
  // create a dynamic value
  var dynamicValue = DynamicValue('com.luckymarmot.PawExtensions.RegexDynamicValue', {
        'input':'support@paw.cloud',
        'regex':'([\w\-\_\.]+)\@[\w\-\_\.]+\.\w+',
        'replacement':'\1'
  });

  // read the dynamic value type/identifier
  console.log(dynamicValue.type); // "com.luckymarmot.PawExtensions.RegexDynamicValue"
}

Dynamic Properties

Dynamic Properties¶

Each type of dynamic value defines custom properties, these properties will be available to access and mutate through JavaScript properties.

function import(context, items, options) {

  // create a dynamic value
  var dynamicValue = DynamicValue('com.luckymarmot.PawExtensions.RegexDynamicValue', {
        'input':'support@paw.cloud',
        'regex':'([\w\-\_\.]+)\@[\w\-\_\.]+\.\w+',
        'replacement':'\1'
  });

  // set the input property
  dynamicValue.input = "micha@paw.cloud";
}

toString

toString¶

Returns: None: string
Returns a simple and pretty representation of the dynamic value.

function import(context, items, options) {

  // create a dynamic value
  var dynamicValue = DynamicValue('com.luckymarmot.HashDynamicValue', {
        'input':'MY_TOKEN'
  });

  console.log(dynamicValue.toString()); // DynamicValue<com.luckymarmot.HashDynamicValue>
}

getEvaluatedString

getEvaluatedString¶

Returns: None: string
Evaluates the dynamic value and returns the string.

function import(context, items, options) {

  // create a dynamic value
  var dynamicValue = DynamicValue('com.luckymarmot.HashDynamicValue', {
        'input':'MY_TOKEN'
  });

  console.log(dynamicValue.getEvaluatedString());
  // 1f27bb78c3de8d3833243e9eb6b4b43aa84fa9e0
}