Class WasmSupport

Index

Constructors

constructor

new WasmSupport(
    desiredFeatures: (
        | "bigInt"
        | "bulkMemory"
        | "exceptions"
        | "extendedConst"
        | "gc"
        | "memory64"
        | "multiValue"
        | "mutableGlobals"
        | "referenceTypes"
        | "relaxedSimd"
        | "saturatedFloatToInt"
        | "signExtensions"
        | "simd"
        | "streamingCompilation"
        | "tailCall"
        | "threads"
    )[],
): WasmSupport
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
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:55

Properties

`Protected`desiredFeatures

The desired feature set

Accessors

allowWasm

get allowWasm(): boolean
Is Wasm allowed

Returns boolean
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:60
set allowWasm(v: boolean): void
Whether or not to allow WASM usage
Parameters
- v: boolean
Returns void
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:67

canUseWasm

get canUseWasm(): boolean
Whether or not Wasm should be used based on the desired feature set, initialization state, or force-use settings

Returns boolean
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:75

featureSupport

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,
        >,
    >,
>
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:90

forceWasm

get forceWasm(): boolean
Force use of Wasm

Returns boolean
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:97
set forceWasm(v: boolean): void
Whether or not to force Wasm usage
Parameters
- v: boolean
Returns void
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:104

isDesiredFeatureSetSupported

get isDesiredFeatureSetSupported(): boolean
Whether or not Wasm is supported based on the desired feature set

Returns boolean
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:112

isInitialized

get isInitialized(): boolean
Whether or not Wasm detection has been run for the desired feature set

Returns boolean
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:120

Methods

`Protected`detectDesiredFeatures

detectDesiredFeatures(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:156

featureCheck

featureCheck(
    features: (
        | "bigInt"
        | "bulkMemory"
        | "exceptions"
        | "extendedConst"
        | "gc"
        | "memory64"
        | "multiValue"
        | "mutableGlobals"
        | "referenceTypes"
        | "relaxedSimd"
        | "saturatedFloatToInt"
        | "signExtensions"
        | "simd"
        | "streamingCompilation"
        | "tailCall"
        | "threads"
    )[],
): Promise<boolean>
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
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:142

initialize

initialize(): Promise<void>
Does feature detection for the desired feature set

Returns Promise<void>
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:150

`Static`create

create(
    desiredFeatures: (
        | "bigInt"
        | "bulkMemory"
        | "exceptions"
        | "extendedConst"
        | "gc"
        | "memory64"
        | "multiValue"
        | "mutableGlobals"
        | "referenceTypes"
        | "relaxedSimd"
        | "saturatedFloatToInt"
        | "signExtensions"
        | "simd"
        | "streamingCompilation"
        | "tailCall"
        | "threads"
    )[],
): Promise<WasmSupport>
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
- Defined in packages/protocol/packages/core/packages/wasm/src/WasmSupport.ts:131

Class WasmSupport

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WasmSupport

Properties

ProtecteddesiredFeatures

Accessors

allowWasm

Returns boolean

Parameters

Returns void

canUseWasm

Returns boolean

featureSupport

forceWasm

Returns boolean

Parameters

Returns void

isDesiredFeatureSetSupported

Returns boolean

isInitialized

Returns boolean

Methods

ProtecteddetectDesiredFeatures

Returns Promise<void>

featureCheck

Parameters

Returns Promise<boolean>

initialize

Returns Promise<void>

Staticcreate

Parameters

Returns Promise<WasmSupport>

Settings

On This Page

`Protected`desiredFeatures

`Protected`detectDesiredFeatures

`Static`create