Interface Flash

interface Flash {
    isFlashSupported(): boolean;
    listSupportedOperations(): string;
    multiLoadEnd(): void;
    multiLoadStart(): void;
    performOperation(operation: string): void;
}

Index

Methods

isFlashSupported listSupportedOperations multiLoadEnd multiLoadStart performOperation

Methods

isFlashSupported

isFlashSupported(): boolean
Determines if flash is supported for the current device.

Returns boolean
true if flash is supported on the current device, false otherwise.
Example
```
if (session.flash.isFlashSupported()) {
  // perform flash operations...
}
```

listSupportedOperations

listSupportedOperations(): string
Queries the list of flash operations supported for the current device.

Returns string
A string containing a list of all the supported operations.
Remarks
Will throw if flash is not supported for the current device.

Example
```
// Print the list of supported operations
console.log(session.flash.listSupportedOperations());
```

multiLoadEnd

multiLoadEnd(): void
Called to finish a multi-load operation. The flash manager will return to default mode (erasing flash based on user settings).

Returns void
Example
```
session.flash.multiLoadStart();

// multiple program loads...

session.flash.multiLoadEnd();
```

multiLoadStart

multiLoadStart(): void
Should be called to start a multi-load operation. The flash manager will only erase the flash on the first program load. Once the Flash Manger receives this call, users will be free to call Memory.loadProgram and Memory.loadBinaryProgram as many times as needed to write to the Flash

Returns void
Example
```
session.flash.multiLoadStart();

// multiple program loads...

session.flash.multiLoadEnd();
```

performOperation

performOperation(operation): void
Performs the specified flash operation. A list of all available operations for the current device can be obtained by calling Flash.listSupportedOperations.
Parameters
- operation: string
  The operation to be performed
Returns void
Remarks
Will throw if the operation is not valid or if flash is not supported for the current device.

Example
```
// Erases the flash (assuming the operation is supported and named "Erase")
session.flash.performOperation("Erase");
```