XYO Platform SDK - v3.10.6
    Preparing search index...

    Class WasmSupport

    Index

    Constructors

    constructor

    Properties

    desiredFeatures

    Accessors

    allowWasm canUseWasm featureSupport forceWasm isDesiredFeatureSetSupported isInitialized

    Methods

    detectDesiredFeatures featureCheck initialize create

    Constructors

    • Instance constructor for use where async instantiation is not possible. Where possible, prefer the static create method over use of this constructor directly as no initialization (feature detection) is able to be done here

      Parameters

      • desiredFeatures: (
            | "bigInt"
            | "bulkMemory"
            | "exceptions"
            | "extendedConst"
            | "gc"
            | "memory64"
            | "multiValue"
            | "mutableGlobals"
            | "referenceTypes"
            | "relaxedSimd"
            | "saturatedFloatToInt"
            | "signExtensions"
            | "simd"
            | "streamingCompilation"
            | "tailCall"
            | "threads"
        )[]

        The desired feature set

      Returns WasmSupport

    Properties

    desiredFeatures: (
        | "bigInt"
        | "bulkMemory"
        | "exceptions"
        | "extendedConst"
        | "gc"
        | "memory64"
        | "multiValue"
        | "mutableGlobals"
        | "referenceTypes"
        | "relaxedSimd"
        | "saturatedFloatToInt"
        | "signExtensions"
        | "simd"
        | "streamingCompilation"
        | "tailCall"
        | "threads"
    )[]

    Accessors

    • get allowWasm(): boolean

      Is Wasm allowed

      Returns boolean

    • set allowWasm(v: boolean): void

      Whether or not to allow WASM usage

      Parameters

      • v: boolean

      Returns void

    • get canUseWasm(): boolean

      Whether or not Wasm should be used based on the desired feature set, initialization state, or force-use settings

      Returns boolean

    • get featureSupport(): Readonly<
          Partial<
              Record<
                  | "bigInt"
                  | "bulkMemory"
                  | "exceptions"
                  | "extendedConst"
                  | "gc"
                  | "memory64"
                  | "multiValue"
                  | "mutableGlobals"
                  | "referenceTypes"
                  | "relaxedSimd"
                  | "saturatedFloatToInt"
                  | "signExtensions"
                  | "simd"
                  | "streamingCompilation"
                  | "tailCall"
                  | "threads",
                  boolean,
              >,
          >,
      >

      Returns a object containing a property for each desired wasm feature with a boolean value indicating whether or not the feature is supported

      Returns Readonly<
          Partial<
              Record<
                  | "bigInt"
                  | "bulkMemory"
                  | "exceptions"
                  | "extendedConst"
                  | "gc"
                  | "memory64"
                  | "multiValue"
                  | "mutableGlobals"
                  | "referenceTypes"
                  | "relaxedSimd"
                  | "saturatedFloatToInt"
                  | "signExtensions"
                  | "simd"
                  | "streamingCompilation"
                  | "tailCall"
                  | "threads",
                  boolean,
              >,
          >,
      >

    • get forceWasm(): boolean

      Force use of Wasm

      Returns boolean

    • set forceWasm(v: boolean): void

      Whether or not to force Wasm usage

      Parameters

      • v: boolean

      Returns void

    • get isDesiredFeatureSetSupported(): boolean

      Whether or not Wasm is supported based on the desired feature set

      Returns boolean

    • get isInitialized(): boolean

      Whether or not Wasm detection has been run for the desired feature set

      Returns boolean

    Methods

    • Returns Promise<void>

    • Checks for specific wasm features

      Parameters

      • features: (
            | "bigInt"
            | "bulkMemory"
            | "exceptions"
            | "extendedConst"
            | "gc"
            | "memory64"
            | "multiValue"
            | "mutableGlobals"
            | "referenceTypes"
            | "relaxedSimd"
            | "saturatedFloatToInt"
            | "signExtensions"
            | "simd"
            | "streamingCompilation"
            | "tailCall"
            | "threads"
        )[]

        The list of features to check for

      Returns Promise<boolean>

      True if all the features are supported, false otherwise

    • Does feature detection for the desired feature set

      Returns Promise<void>

    • Static creation & async initialization for use where async instantiation is possible

      Parameters

      • desiredFeatures: (
            | "bigInt"
            | "bulkMemory"
            | "exceptions"
            | "extendedConst"
            | "gc"
            | "memory64"
            | "multiValue"
            | "mutableGlobals"
            | "referenceTypes"
            | "relaxedSimd"
            | "saturatedFloatToInt"
            | "signExtensions"
            | "simd"
            | "streamingCompilation"
            | "tailCall"
            | "threads"
        )[]

        The desired feature set

      Returns Promise<WasmSupport>

      An initialized instance of the class with detection for the desired feature set

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods