Skip to content

Commit aba8072

Browse files
authored
docs(@sanity): remove @beta tags from migrate (#7490)
1 parent 94f5db3 commit aba8072

File tree

2 files changed

+0
-17
lines changed

2 files changed

+0
-17
lines changed

packages/@sanity/migrate/src/mutations/creators.ts

-6
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import {type NormalizeReadOnlyArray, type Optional, type Tuplify} from './typeUt
2020
* Creates a new document.
2121
* @param document - The document to be created.
2222
* @returns The mutation to create the document.
23-
* @beta
2423
*/
2524
export function create<Doc extends Optional<SanityDocument, '_id'>>(
2625
document: Doc,
@@ -34,7 +33,6 @@ export function create<Doc extends Optional<SanityDocument, '_id'>>(
3433
* @param patches - The patches to be applied.
3534
* @param options - Optional patch options.
3635
* @returns The mutation to patch the document.
37-
* @beta
3836
*/
3937
export function patch<P extends NodePatchList | NodePatch>(
4038
id: string,
@@ -54,7 +52,6 @@ export function patch<P extends NodePatchList | NodePatch>(
5452
* @param path - The path where the operation should be applied.
5553
* @param operation - The operation to be applied.
5654
* @returns The node patch.
57-
* @beta
5855
*/
5956
export function at<O extends Operation>(path: Path | string, operation: O): NodePatch<Path, O> {
6057
return {
@@ -67,7 +64,6 @@ export function at<O extends Operation>(path: Path | string, operation: O): Node
6764
* Creates a document if it does not exist.
6865
* @param document - The document to be created.
6966
* @returns The mutation operation to create the document if it does not exist.
70-
* @beta
7167
*/
7268
export function createIfNotExists<Doc extends SanityDocument>(
7369
document: Doc,
@@ -79,7 +75,6 @@ export function createIfNotExists<Doc extends SanityDocument>(
7975
* Creates or replaces a document.
8076
* @param document - The document to be created or replaced.
8177
* @returns The mutation operation to create or replace the document.
82-
* @beta
8378
*/
8479
export function createOrReplace<Doc extends SanityDocument>(
8580
document: Doc,
@@ -91,7 +86,6 @@ export function createOrReplace<Doc extends SanityDocument>(
9186
* Deletes a document.
9287
* @param id - The id of the document to be deleted.
9388
* @returns The mutation operation to delete the document.
94-
* @beta
9589
*/
9690
export function delete_(id: string): DeleteMutation {
9791
return {type: 'delete', id}

packages/@sanity/migrate/src/mutations/operations/creators.ts

-11
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ import {
2121
* @param value - The value to set.
2222
* @returns A `set` operation.
2323
* {@link https://www.sanity.io/docs/http-patches#6TPENSW3}
24-
* @beta
2524
*
2625
* @example
2726
* ```ts
@@ -36,7 +35,6 @@ export const set = <const T>(value: T): SetOp<T> => ({type: 'set', value})
3635
* @param value - The value to set if missing.
3736
* @returns A `setIfMissing` operation.
3837
* {@link https://www.sanity.io/docs/http-patches#A80781bT}
39-
* @beta
4038
* @example
4139
* ```ts
4240
* const setFooIfMissing = setIfMissing('foo')
@@ -52,7 +50,6 @@ export const setIfMissing = <const T>(value: T): SetIfMissingOp<T> => ({
5250
* Creates an `unset` operation.
5351
* @returns An `unset` operation.
5452
* {@link https://www.sanity.io/docs/http-patches#xRtBjp8o}
55-
* @beta
5653
*
5754
* @example
5855
* ```ts
@@ -66,7 +63,6 @@ export const unset = (): UnsetOp => ({type: 'unset'})
6663
* @param amount - The amount to increment by.
6764
* @returns An incrementation operation for numeric values
6865
* {@link https://www.sanity.io/docs/http-patches#vIT8WWQo}
69-
* @beta
7066
*
7167
* @example
7268
* ```ts
@@ -84,7 +80,6 @@ export const inc = <const N extends number = 1>(amount: N = 1 as N): IncOp<N> =>
8480
* @param amount - The amount to decrement by.
8581
* @returns A `dec` operation.
8682
* {@link https://www.sanity.io/docs/http-patches#vIT8WWQo}
87-
* @beta
8883
*
8984
* @example
9085
* ```ts
@@ -116,7 +111,6 @@ export const diffMatchPatch = (value: string): DiffMatchPatchOp => ({
116111
* @param indexOrReferenceItem - The index or reference item to insert before or after.
117112
* @returns An `insert` operation for adding values to arrays
118113
* {@link https://www.sanity.io/docs/http-patches#febxf6Fk}
119-
* @beta
120114
*
121115
* @example
122116
* ```ts
@@ -147,7 +141,6 @@ export function insert<
147141
* @param items - The items to append.
148142
* @returns An `insert` operation for adding a value to the end of an array.
149143
* {@link https://www.sanity.io/docs/http-patches#Cw4vhD88}
150-
* @beta
151144
*
152145
* @example
153146
* ```ts
@@ -165,7 +158,6 @@ export function append<const Items extends AnyArray<unknown>>(items: Items | Arr
165158
* @param items - The items to prepend.
166159
* @returns An `insert` operation for adding a value to the start of an array.
167160
* {@link https://www.sanity.io/docs/http-patches#refAUsf0}
168-
* @beta
169161
*
170162
* @example
171163
* ```ts
@@ -205,7 +197,6 @@ export function insertBefore<
205197
* @param indexOrReferenceItem - The index or reference item to insert after.
206198
* @returns An `insert` operation after the provided index or reference item.
207199
* {@link https://www.sanity.io/docs/http-patches#0SQmPlb6}
208-
* @beta
209200
*
210201
* @example
211202
* ```ts
@@ -230,7 +221,6 @@ export const insertAfter = <
230221
* @returns A `truncate` operation.
231222
* @remarks - This will be converted to an `unset` patch when submitted to the API
232223
* {@link https://www.sanity.io/docs/http-patches#xRtBjp8o}
233-
* @beta
234224
*
235225
* @example
236226
* ```ts
@@ -254,7 +244,6 @@ export function truncate(startIndex: number, endIndex?: number): TruncateOp {
254244
* @returns A ReplaceOp operation.
255245
* @remarks This will be converted to an `insert`/`replace` patch when submitted to the API
256246
* {@link https://www.sanity.io/docs/http-patches#GnVSwcPa}
257-
* @beta
258247
*
259248
* @example
260249
* ```ts

0 commit comments

Comments
 (0)