Skip to content

docs: prefer ConsolaInstance import from consola main entry #440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vittorioexp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: prefer ConsolaInstance import from consola main entry #440

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ import { consola, createConsola } from "consola/browser";
import { createConsola } from "consola/core";
```

When typing values that come from the main `consola` entry (for example `useLogger()` from Nuxt kit), import types from `"consola"` — not `"consola/core"`. The `/core` build is a separate lightweight entry; its types are not always assignable to the main package types.

```ts
import type { ConsolaInstance } from "consola";
```

## Consola Methods

#### `<type>(logObject)` `<type>(args...)`
Expand Down