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

Models exposed to Zeplin extensions

import { VariableMode } from "./variableMode.js";
import { VariableGroup } from "./variableGroup.js";
export interface VariableCollectionData {
    name: string;
    modes: any[];
    groups: any[];
    remote: boolean;
}
/**
 * An interface that represents a variable collection.
 */
export declare class VariableCollection {
    /**
     * Name of the variable collection.
     */
    name: string;
    /**
     * Mode details of the variable collection.
     */
    modes: VariableMode[];
    /**
     * Groups of the variable collection.
     */
    groups: VariableGroup[];
    /**
     * Whether the variable collection is from a remote source
     */
    remote: boolean;
    static get ALLOWED_FIELDS(): string[];
    constructor(variableCollectionData: VariableCollectionData, variableBySourceId?: Record<string, any>, platform?: string);
    /**
     * Creates a VariableCollection instance from a JSON string
     *
     * @param json JSON string representing a variable collection
     * @returns A new VariableCollection instance
     */
    static fromJSON(json: string): VariableCollection;
}