Function open

open(source: string | ArrayBuffer, settings: Partial<VimSettings>, onProgress?: ((p: IProgressLogs) => void)): Promise<Vim>
Asynchronously opens a vim object from a given source with the provided settings.

Returns
A Promise that resolves when the vim object is successfully opened.
Parameters
- source: string | ArrayBuffer
  
  The source of the vim object, either a string or an ArrayBuffer.
- settings: Partial<VimSettings>
  
  The settings to configure the behavior of the vim object.
- Optional onProgress: ((p: IProgressLogs) => void)
  
  Optional callback function to track progress logs.
  - - (p: IProgressLogs): void
    - Parameters
      
      p: IProgressLogs
      
      Returns void
Returns Promise<Vim>
- Defined in src/vim-loader/progressive/open.ts:35

Generated using TypeDoc