MVFv3 API Documentation
    Preparing search index...

    Interface MVFExtension<T, Depends, Error>

    A type that describes an extension for an MVF bundle.

    The generic types for the extension should be defined as follows:

    • T should be the schema definition for how you expect the data to be made available once the MVF is loaded.
    • Depends should be an array of the schemas of any extensions you may depend on. For example, if your data is organized per floor, you likely want to depend on FloorSchema. This helps to inform the types available to you when writing the integrityCheck function.
    • Error should be the type of error that the integrity check may throw. It's recommended to base this on IntegrityError. These are what are returned by the integrityCheck function on failure.
    interface MVFExtension<
        T extends TSchema,
        Depends extends TSchema[] = [],
        Error = IntegrityError,
    > {
        fromBundle: (
            path: string,
            contents: Uint8Array,
            decode: (contents: Uint8Array) => unknown,
        ) => undefined | Partial<Static<T>>;
        intoBundle: (data: Partial<Static<T>>) => Generator<BundleFile, void>;
        name: string;
        schema: T;
        integrityCheck?: (
            data: Partial<Static<TComposite<[T, ...Depends]>>>,
        ) => IntegrityResult<Error>;
        references?: TSchema[];
    }

    Type Parameters

    Index

    Properties

    fromBundle intoBundle name schema integrityCheck? references?

    Properties

    fromBundle: (
        path: string,
        contents: Uint8Array,
        decode: (contents: Uint8Array) => unknown,
    ) => undefined | Partial<Static<T>>

    A function that decodes the contents of a file from a bundle. The path is provided to enable filtering, so that only files related to this extension are decoded. Developers are strongly encouraged to immediately reject any files that are not related to this extension. Additionally, developers MUST use the provided decode function when decoding the file contents.

    This method is used to do smart filtering when decoding bundle contents, to avoid decompressing/parsing unused files.

    intoBundle: (data: Partial<Static<T>>) => Generator<BundleFile, void>

    A generator function that yields the files that should be written to the bundle. File contents MUST be JSON-serializable.

    name: string

    The name of the extension.

    schema: T

    The schema of the extension.

    integrityCheck?: (
        data: Partial<Static<TComposite<[T, ...Depends]>>>,
    ) => IntegrityResult<Error>

    A function that performs an integrity check on the data. This should not be used to validate the shape of the data, but rather check for things like referential integrity, or other potential problems that cannot be detected purely from schema validation.

    references?: TSchema[]

    A list of reference schemas that are required for your extension to function properly. The general rule here is that if: a. The schema is defined within this extension, and b. The schema is referenced using Type.Ref, then the schema should be listed here. You SHOULD NOT list schemas that are not used by and do not belong to this extension.

    Settings

    Member Visibility

    On This Page

    Properties