Skip to content

Update composition-api.md #3430

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
luizphillipy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update composition-api.md #3430

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: 3 additions & 3 deletions src/guide/typescript/composition-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,21 +356,21 @@ It's recommended to place the injection key in a separate file so that it can be
When using string injection keys, the type of the injected value will be `unknown`, and needs to be explicitly declared via a generic type argument:

```ts
const foo = inject<string>('foo') // type: string | undefined
const foo = inject<string>(key) // type: string | undefined
```

Notice the injected value can still be `undefined`, because there is no guarantee that a provider will provide this value at runtime.

The `undefined` type can be removed by providing a default value:

```ts
const foo = inject<string>('foo', 'bar') // type: string
const foo = inject<string>(key, 'bar') // type: string
```

If you are sure that the value is always provided, you can also force cast the value:

```ts
const foo = inject('foo') as string
const foo = inject(key) as string
```

## Typing Template Refs {#typing-template-refs}
Expand Down