Skip to content

Commit

Permalink
Documentation Fix: Correct cacheTag Function Usage (vercel#71912)
Browse files Browse the repository at this point in the history
<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:
-->

## What?

### Documentation Fix: Correct `cacheTag` Function Usage

**Issue**: The [current
documentation](https://nextjs.org/docs/canary/app/api-reference/functions/cacheTag#notes)
incorrectly states that `cacheTag` accepts an array of tags. However,
the [source
code](https://github.com/vercel/next.js/blob/ca5f29d81b011c3a01e2372118b29836f1df0fa7/packages/next/src/server/use-cache/cache-tag.ts#L4C1-L4C52)
implementation uses rest parameters (`...tags: string[]`), expecting
individual string arguments rather than an array.

**Changes**:
Updated the "Notes" section to reflect the function's correct usage:

## Why?

This change:
1. Aligns with the actual implementation in the source code
2. Prevents TypeScript errors when users follow the documentation
3. Provides clearer guidance on using the function with both direct
arguments and arrays (using the spread operator)

The current documentation might lead developers to encounter the
TypeScript error:
> "Argument of type 'string[]' is not assignable to parameter of type
'string'"

## Related

Fixes vercel#71901

Co-authored-by: Delba de Oliveira <[email protected]>
  • Loading branch information
2 people authored and stipsan committed Nov 6, 2024
1 parent e59b8d5 commit a7e1fa3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/02-app/02-api-reference/04-functions/cacheTag.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -132,5 +132,5 @@ export async function updateBookings() {
- **Multiple Tags**: You can assign multiple tags to a single cache entry by passing an array to `cacheTag`.

```tsx
cacheTag(['tag-one', 'tag-two'])
cacheTag('tag-one', 'tag-two')
```

0 comments on commit a7e1fa3

Please sign in to comment.