{
  "$schema": "../../schemas/utility.schema.json",
  "kind": "utility",
  "name": "Durations",
  "version": "1.0.0-draft.1",
  "purpose": "Durations value operations. No hidden external Service communication.",
  "types": "types.json",
  "functions": {
    "of": {
      "parameters": [
        {
          "name": "amount",
          "type": "core.integer",
          "required": true
        },
        {
          "name": "unit",
          "type": "core.string",
          "required": true
        }
      ],
      "returns": "core.duration",
      "purpose": "Duration from integer milliseconds/seconds/minutes/hours.",
      "statementOnly": false
    },
    "between": {
      "parameters": [
        {
          "name": "start",
          "type": "core.datetime",
          "required": true
        },
        {
          "name": "end",
          "type": "core.datetime",
          "required": true
        }
      ],
      "returns": "core.duration",
      "purpose": "Signed elapsed duration between datetimes.",
      "statementOnly": false
    },
    "amount": {
      "parameters": [
        {
          "name": "value",
          "type": "core.duration",
          "required": true
        },
        {
          "name": "unit",
          "type": "core.string",
          "required": true
        }
      ],
      "returns": "core.decimal",
      "purpose": "Decimal conversion to an elapsed unit.",
      "statementOnly": false
    }
  },
  "rules": [
    "Durations measure signed elapsed time, not calendar periods. Supported units are milliseconds, seconds, minutes and hours.",
    "of accepts an integer amount. between computes elapsed datetime difference. amount returns the decimal conversion in the requested unit."
  ]
}
