Interface UploaderInterface<P>

Type parameters

P: DeviceConnectionInterface

Hierarchy

UploaderInterface

Index

Methods

Methods

Optional afterRunCode

afterRunCode(code: string, error?: unknown): Promise<void>

运行代码之后的钩子, 可以作为一些释放操作, 例如: 释放掉串口, 检查是否完成
📢注意!!!:
- 无论 {@link DeviceUploadInterface.runCode} 是否执行成功, 该钩子都会执行
- 运行流程不会等待该钩子执行完成, 阻塞该该钩子可能无法完成操作, 如果有需要阻塞的, 请放到 {@link DeviceUploadInterface.runCode} 里面处理
Parameters
- code: string
  
  代码
- Optional error: unknown
Returns Promise<void>

Optional afterUploadCode

afterUploadCode(code: string, error?: unknown): Promise<void>

烧录代码之后的钩子, 可以作为一些释放操作, 例如: 释放掉串口, 检查是否完成, 脚本是否正在运行等
📢注意!!!:
- 无论 {@link DeviceUploadInterface.uploadCode} 是否执行成功, 该钩子都会执行
- 烧录流程不会等待该钩子执行完成, 阻塞该该钩子可能无法完成操作, 如果有需要阻塞的, 请放到 {@link DeviceUploadInterface.uploadCode} 里面处理
hook
Parameters
- code: string
  
  代码字符串会把 {@link DeviceUploadInterface.uploadCode} 代码作为参数传入
- Optional error: unknown
  
  如果前面的操作有报错, 会把错误传到这里
Returns Promise<void>

Optional beforeRunCode

beforeRunCode(code: string): Promise<void | { code: string }>

运行代码之前的钩子

可以做一些检查操作或者对代码进行二次加工, 如果返回的 code 非空, 会直接作为 {@link DeviceUploadInterface.runCode} 的参数传入

📢注意: 如果 {@link DeviceUploadInterface.runCode} 不存在的话, 不会执行这个钩子

hook
Parameters
- code: string
  
  代码
Returns Promise<void | { code: string }>

Optional beforeUploadCode

beforeUploadCode(code: string): Promise<void | { code: string }>

hook
烧录代码前的钩子, 可以做一些检查操作, 或者对代码进行二次加工, 如果返回的 code 非空, 会直接作为 {@link DeviceUploadInterface.uploadCode} 的参数传入

Parameters
- code: string
Returns Promise<void | { code: string }>

Optional destroy

destroy(): Promise<void>

销毁

Returns Promise<void>

Optional interrupt

interrupt(action: "upload" | "run"): Promise<void>

当烧录或者运行过程中, 用户点击强制取消, 会执行该函数, 如果中断需要执行某些销毁动作, 请在这个钩子处理

📢注意: 如果用户选择取消等待, 会直接退出

Parameters
- action: "upload" | "run"
  
  中断的行为, 烧录是: 'upload', 运行是: 'run'
Returns Promise<void>

Optional prepareEnv

prepareEnv(debugCallback?: (data: string) => void, progressCallback?: (progress: number) => void): Promise<void>

环境准备

Parameters
- Optional debugCallback: (data: string) => void
  - - (data: string): void
    - Parameters
      - data: string
      Returns void
- Optional progressCallback: (progress: number) => void
  - - (progress: number): void
    - Parameters
      - progress: number
      Returns void
Returns Promise<void>

Optional runCode

runCode(code: string, debugCallback?: (data: string) => void, progressCallback?: (progress: number) => void): Promise<void>

运行代码可以和 upload 作为两个不同类型

Parameters
- code: string
- Optional debugCallback: (data: string) => void
  - - (data: string): void
    - Parameters
      - data: string
      Returns void
- Optional progressCallback: (progress: number) => void
  - - (progress: number): void
    - Parameters
      - progress: number
      Returns void
Returns Promise<void>

Optional switchMode

switchMode(mode: WorkingModeType): Promise<void>

切换模式的时候会触发这里

注意, 如果用户没有初始化烧录模式, 点击在线模式, 是不会到这里的

Parameters
- mode: WorkingModeType
  
  模式 Upload 或者 Online
Returns Promise<void>

uploadCode

uploadCode(code: string, debugCallback?: (data: string) => void, progressCallback?: (progress: number) => void): Promise<void>

烧录代码

Parameters
- code: string
  
  代码字符串
- Optional debugCallback: (data: string) => void
  
  调试窗口 callback
  - - (data: string): void
    - Parameters
      - data: string
      Returns void
- Optional progressCallback: (progress: number) => void
  
  进度 callback
  - - (progress: number): void
    - Parameters
      - progress: number
      Returns void
Returns Promise<void>

Generated using TypeDoc