Skip to content

Commit 5d2a8ed

Browse files
committed
Use provisional backfill since tags
Keep the new backfill API documentation on provisional 2.x.0 since tags until the feature branch is ready to merge and the target release version is known. Assisted-by: Codex:gpt-5
1 parent bdf65df commit 5d2a8ed

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

packages/backfill/src/backfill.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import type {
1717
/**
1818
* Thrown when backfill traversal exceeds the configured request budget.
1919
*
20-
* @since 2.3.0
20+
* @since 2.x.0
2121
*/
2222
export class MaxRequestsExceeded extends Error {}
2323

@@ -32,7 +32,7 @@ interface RequestBudget {
3232
* The seed object is not yielded by default, but its ID is treated as already
3333
* seen so it will not be yielded again if the collection contains it.
3434
*
35-
* @since 2.3.0
35+
* @since 2.x.0
3636
*/
3737
export async function* backfill<
3838
TObject extends APObject = APObject,

packages/backfill/src/types.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@ import type { Object as APObject } from "@fedify/vocab";
33
/**
44
* Backfill traversal strategy used to discover the returned object.
55
*
6-
* @since 2.3.0
6+
* @since 2.x.0
77
*/
88
export type BackfillStrategy = "context-posts";
99

1010
/**
1111
* Source relation that produced a backfilled object.
1212
*
13-
* @since 2.3.0
13+
* @since 2.x.0
1414
*/
1515
export type BackfillOrigin = "context" | "collection";
1616

1717
/**
1818
* Options passed to {@link BackfillDocumentLoader}.
1919
*
20-
* @since 2.3.0
20+
* @since 2.x.0
2121
*/
2222
export interface BackfillDocumentLoaderOptions {
2323
/**
@@ -29,7 +29,7 @@ export interface BackfillDocumentLoaderOptions {
2929
/**
3030
* Dereferences an ActivityPub object or collection IRI.
3131
*
32-
* @since 2.3.0
32+
* @since 2.x.0
3333
*/
3434
export type BackfillDocumentLoader = (
3535
iri: URL,
@@ -39,7 +39,7 @@ export type BackfillDocumentLoader = (
3939
/**
4040
* Dependencies used by backfill traversal.
4141
*
42-
* @since 2.3.0
42+
* @since 2.x.0
4343
*/
4444
export interface BackfillContext {
4545
/**
@@ -51,7 +51,7 @@ export interface BackfillContext {
5151
/**
5252
* Controls direct context collection backfill traversal.
5353
*
54-
* @since 2.3.0
54+
* @since 2.x.0
5555
*/
5656
export interface BackfillOptions<
5757
TObject extends APObject = APObject,
@@ -93,7 +93,7 @@ export interface BackfillOptions<
9393
/**
9494
* A single object discovered by backfill traversal.
9595
*
96-
* @since 2.3.0
96+
* @since 2.x.0
9797
*/
9898
export interface BackfillItem<
9999
TObject extends APObject = APObject,

0 commit comments

Comments
 (0)