Skip to content

Commit fafe24e

Browse files
committed
docs: clarify breadcrumbs behavior in README and index.ts
1 parent 5399d08 commit fafe24e

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ HawkCatcher.init({
207207

208208
#### Manual breadcrumbs
209209

210-
Add custom breadcrumbs manually (they are attached to the next event sent):
210+
Add custom breadcrumbs manually. Breadcrumbs accumulate in a buffer and are attached to every event until explicitly cleared via `HawkCatcher.breadcrumbs.clear()`:
211211

212212
```js
213213
HawkCatcher.breadcrumbs.add({

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ export default class HawkCatcher {
367367
* Breadcrumbs API - same surface as in @hawk.so/javascript (add, get, clear)
368368
*/
369369
export interface BreadcrumbsAPI {
370-
/** Add a breadcrumb to the buffer (attached to the next sent event) */
370+
/** Add a breadcrumb to the buffer (attached to every event until cleared) */
371371
add(breadcrumb: BreadcrumbInput, hint?: BreadcrumbHint): void;
372372

373373
/** Get current breadcrumbs snapshot (oldest to newest) */

0 commit comments

Comments
 (0)