@sitecore/sc-contenthub-webclient-sdk/dist/contracts/base/member.d.ts

Sitecore Content Hub WebClient SDK.

import { IDirtyTracking } from "../dirty-tracking/dirty-tracking";
import { MemberDefinitionType } from "./member-definition-type";
/**
 * Base interface for all members (properties and relations).
 */
export interface IMember extends IDirtyTracking {
    /**
     * {@link MemberDefinition}
     */
    name: string;
    /**
     * The {@link MemberDefinitionType} of the member definition.
     */
    definitionType: MemberDefinitionType;
}
export declare abstract class MemberBase implements IMember {
    name: string;
    isTracking: boolean;
    readonly definitionType: MemberDefinitionType;
    abstract readonly isDirty: boolean;
    abstract startTracking(): void;
    abstract markClean(): void;
    constructor(name: string, definitionType: MemberDefinitionType);
    /**
     * Returns a string representation of the current member instance.
     *
     * @remarks
     * Can not be used for serialization. Only useful during debugging or testing.
     * Returned format: \<member name\> ({@link MemberDefinitionType}) (\<constructor.name\>)
     */
    toString(): string;
}