svelte-command

general command execution handling for svelte components

API

Table of Contents

• BasicCommand
  • Parameters
  • subscribe
    • Parameters
• Command
  • Parameters
  • Properties
• ConfirmCommand
  • Parameters
• FetchCommand
  • Parameters
• handleFailedResponse
  • Parameters

BasicCommand

Parameters

• start
• properties
• options (optional, default {})

subscribe

Parameters

• subscription Function

Command

Extends BasicCommand

Parameters

• _start
• options (optional, default {})

Properties

• title string
• description string
• shortcuts string
• disabled boolean
• active boolean
• failed boolean
• completed boolean

ConfirmCommand

Extends BasicCommand

Ask for confirmation before execution a given Command.

Parameters

• command

FetchCommand

Extends Command

Command executing a fetch request.

Parameters

• url any
• fetchOptions Object
• options Object (optional, default {})

handleFailedResponse

Extract error description from response.

Parameters

• response Response

Returns Promise<string>

install

With npm do:

npm install svelte-command

With yarn do:

yarn add svelte-command

license

BSD-2-Clause