adaptive-expressions/src/builtinFunctions/ticks.ts

Common Expression Language

/**
 * @module adaptive-expressions
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

import { Expression } from '../expression';
import { ExpressionEvaluator, ValueWithError } from '../expressionEvaluator';
import { ExpressionType } from '../expressionType';
import { FunctionUtils } from '../functionUtils';
import { InternalFunctionUtils } from '../functionUtils.internal';
import { MemoryInterface } from '../memory/memoryInterface';
import { Options } from '../options';
import { ReturnType } from '../returnType';

/**
 * Return the ticks property value of a specified timestamp. A tick is 100-nanosecond interval.
 */
export class Ticks extends ExpressionEvaluator {
    /**
     * Initializes a new instance of the [Ticks](xref:adaptive-expressions.Ticks) class.
     */
    constructor() {
        super(ExpressionType.Ticks, Ticks.evaluator, ReturnType.Number, Ticks.validator);
    }

    /**
     * @private
     */
    private static evaluator(expr: Expression, state: MemoryInterface, options: Options): ValueWithError {
        let value: any;
        const { args, error: childrenError } = FunctionUtils.evaluateChildren(expr, state, options);
        let error = childrenError;
        if (!error) {
            if (typeof args[0] === 'string') {
                ({ value, error } = InternalFunctionUtils.ticks(args[0]));
            } else {
                error = `${expr} should contain an ISO format timestamp.`;
            }
        }

        return { value, error };
    }

    /**
     * @private
     */
    private static validator(expression: Expression): void {
        FunctionUtils.validateArityAndAnyType(expression, 1, 1, ReturnType.String);
    }
}