﻿> These docs cover Nitro Cookies 1.3.0. List APIs, scoped deletion, and normalized errors are available from 1.3.0. Check the installation guide and release history when upgrading from an earlier version.

# API overview

Import the default `NitroCookies` object to access all 23 operations.
Signatures in this reference describe methods on that object.

```ts
import NitroCookies, {
  CookieErrorCode,
  type Cookie,
  type CookieIdentifier,
  type Cookies,
  type CookieError,
} from "react-native-nitro-cookies";
```

## Find an operation

| Task                                    | Methods                                                                              | Reference                               |
| --------------------------------------- | ------------------------------------------------------------------------------------ | --------------------------------------- |
| Read stored cookies                     | `getSync`, `get`, `getListSync`, `getList`, `getAll`, `getAllList`                   | [Read cookies](https://l2hyunwoo.github.io/react-native-nitro-cookies/reference/reading.md)               |
| Write cookies                           | `setSync`, `set`, `setManySync`, `setMany`, `setFromResponseSync`, `setFromResponse` | [Write cookies](https://l2hyunwoo.github.io/react-native-nitro-cookies/reference/writing.md)              |
| Build headers or fetch response cookies | `getCookieHeaderSync`, `getCookieHeader`, `getFromResponse`, `getFromResponseList`   | [Headers and responses](https://l2hyunwoo.github.io/react-native-nitro-cookies/reference/requests.md)     |
| Delete cookies                          | `clearCookieSync`, `clearCookie`, `clearByNameSync`, `clearByName`, `clearAll`       | [Delete cookies](https://l2hyunwoo.github.io/react-native-nitro-cookies/reference/deletion.md)            |
| Persist or remove session cookies       | `flush`, `removeSessionCookies`                                                      | [Persistence and sessions](https://l2hyunwoo.github.io/react-native-nitro-cookies/reference/lifecycle.md) |

## Shared conventions

- Supply a full HTTP(S) URL where a URL is required.
- `useWebKit` is an optional boolean argument, not an options object. Its default is `false`.
- Sync methods use the default store. Async methods return a Promise, but completion guarantees still depend on the platform and operation.
- Dictionary results use cookie names as keys. Lists preserve duplicate names.
- Failures in the wrapper expose a string `code`. Read the [error contract](https://l2hyunwoo.github.io/react-native-nitro-cookies/reference/errors.md) before implementing recovery.

The list/scoped-deletion APIs and normalized error contract are **available in 1.3.0**.
See [installation](https://l2hyunwoo.github.io/react-native-nitro-cookies/start/installation.md) for release availability and upgrade steps.

See [types](https://l2hyunwoo.github.io/react-native-nitro-cookies/reference/types.md) for data shapes and [platform support](https://l2hyunwoo.github.io/react-native-nitro-cookies/reference/platforms.md) for availability.

## Documentation for AI tools

Use [llms.txt](https://l2hyunwoo.github.io/react-native-nitro-cookies/llms.txt) to find Markdown pages by topic, or [llms-full.txt](https://l2hyunwoo.github.io/react-native-nitro-cookies/llms-full.txt) to read the complete English documentation in one file.
Both files are generated from these docs and include the same release guidance and platform limits.
