Skip to content

Upgrading ora 3 to 4

Breaking3.4.0 → 4.1.1Breaking2Platform1Fixed8

Full comparisonBack to ora
BreakingUpgrade verdict

2 breaking changes and a platform requirement change.

In plain terms
  • The spinner no longer reads keyboard input by default, so it stays steady and does not swallow what you type.
  • TypeScript users must switch from a default import to a require-style import.
  • You need Node.js version 8 or newer to use this package.
Must act 3 items need code or config changes

Node.js requirement changed in 4.0.0: >=6 → >=8.

Adds is-interactive ^1.0.0, mute-stream 0.0.8.

Installs 27 packages in all (was 19).

What you must change

Breaking2
Discards stdin by default, preventing spinner twitching, broken lines on Enter, and input buffering.
4.0.0GitHub ReleaseSummarizedView source
Uses only a CommonJS export for the TypeScript definition, changing the required import syntax.
ora
4.0.0GitHub ReleaseSummarizedView source
Platform1
Requires Node.js 8 or later.
4.0.0GitHub ReleaseSummarizedView source

API changes

Generated by DepDelta from published .d.ts files. Not mixed with prose notes.

  • changed: const ora: { (options?: ora.Options | string): ora.Ora; promise(action: PromiseLike<unknown>, options?: ora.Options | string): ora.Ora; default: typeof ora } → const ora: { (options?: ora.Options | string): ora.Ora; promise(action: PromiseLike<unknown>, options?: ora.Options | string): ora.Ora }
  • changed: method ora.Ora.frame(): Ora → method ora.Ora.frame(): string
  • added: readonly property ora.Options.discardStdin?: boolean