@zeplin/extension-model/dist/variable.d.ts

Models exposed to Zeplin extensions

import { VariableValue } from "./variableValue.js";
export interface VariableData {
    name: string;
    sourceId: string;
    values: any[];
}
/**
 * An interface that represents a variable.
 */
export declare class Variable {
    /**
     * Original name of the variable.
     */
    originalName: string;
    /**
     * Formatted name of the variable.
     */
    name: string;
    /**
     * Unique identifier of the variable.
     */
    sourceId: string;
    /**
     * Values of the variable for different modes.
     */
    values: VariableValue[];
    static get ALLOWED_FIELDS(): string[];
    constructor(variableData: VariableData, variableGroupName?: string, variableBySourceId?: Record<string, any>, platform?: string);
    /**
     * Creates a Variable instance from a JSON string
     *
     * @param json JSON string representing a variable
     * @returns A new Variable instance
     */
    static fromJSON(json: string): Variable;
}