Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(@sanity): remove @beta tags from migrate #7490

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions packages/@sanity/migrate/src/mutations/creators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import {type NormalizeReadOnlyArray, type Optional, type Tuplify} from './typeUt
* Creates a new document.
* @param document - The document to be created.
* @returns The mutation to create the document.
* @beta
*/
export function create<Doc extends Optional<SanityDocument, '_id'>>(
document: Doc,
Expand All @@ -34,7 +33,6 @@ export function create<Doc extends Optional<SanityDocument, '_id'>>(
* @param patches - The patches to be applied.
* @param options - Optional patch options.
* @returns The mutation to patch the document.
* @beta
*/
export function patch<P extends NodePatchList | NodePatch>(
id: string,
Expand All @@ -54,7 +52,6 @@ export function patch<P extends NodePatchList | NodePatch>(
* @param path - The path where the operation should be applied.
* @param operation - The operation to be applied.
* @returns The node patch.
* @beta
*/
export function at<O extends Operation>(path: Path | string, operation: O): NodePatch<Path, O> {
return {
Expand All @@ -67,7 +64,6 @@ export function at<O extends Operation>(path: Path | string, operation: O): Node
* Creates a document if it does not exist.
* @param document - The document to be created.
* @returns The mutation operation to create the document if it does not exist.
* @beta
*/
export function createIfNotExists<Doc extends SanityDocument>(
document: Doc,
Expand All @@ -79,7 +75,6 @@ export function createIfNotExists<Doc extends SanityDocument>(
* Creates or replaces a document.
* @param document - The document to be created or replaced.
* @returns The mutation operation to create or replace the document.
* @beta
*/
export function createOrReplace<Doc extends SanityDocument>(
document: Doc,
Expand All @@ -91,7 +86,6 @@ export function createOrReplace<Doc extends SanityDocument>(
* Deletes a document.
* @param id - The id of the document to be deleted.
* @returns The mutation operation to delete the document.
* @beta
*/
export function delete_(id: string): DeleteMutation {
return {type: 'delete', id}
Expand Down
11 changes: 0 additions & 11 deletions packages/@sanity/migrate/src/mutations/operations/creators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import {
* @param value - The value to set.
* @returns A `set` operation.
* {@link https://www.sanity.io/docs/http-patches#6TPENSW3}
* @beta
*
* @example
* ```ts
Expand All @@ -36,7 +35,6 @@ export const set = <const T>(value: T): SetOp<T> => ({type: 'set', value})
* @param value - The value to set if missing.
* @returns A `setIfMissing` operation.
* {@link https://www.sanity.io/docs/http-patches#A80781bT}
* @beta
* @example
* ```ts
* const setFooIfMissing = setIfMissing('foo')
Expand All @@ -52,7 +50,6 @@ export const setIfMissing = <const T>(value: T): SetIfMissingOp<T> => ({
* Creates an `unset` operation.
* @returns An `unset` operation.
* {@link https://www.sanity.io/docs/http-patches#xRtBjp8o}
* @beta
*
* @example
* ```ts
Expand All @@ -66,7 +63,6 @@ export const unset = (): UnsetOp => ({type: 'unset'})
* @param amount - The amount to increment by.
* @returns An incrementation operation for numeric values
* {@link https://www.sanity.io/docs/http-patches#vIT8WWQo}
* @beta
*
* @example
* ```ts
Expand All @@ -84,7 +80,6 @@ export const inc = <const N extends number = 1>(amount: N = 1 as N): IncOp<N> =>
* @param amount - The amount to decrement by.
* @returns A `dec` operation.
* {@link https://www.sanity.io/docs/http-patches#vIT8WWQo}
* @beta
*
* @example
* ```ts
Expand Down Expand Up @@ -116,7 +111,6 @@ export const diffMatchPatch = (value: string): DiffMatchPatchOp => ({
* @param indexOrReferenceItem - The index or reference item to insert before or after.
* @returns An `insert` operation for adding values to arrays
* {@link https://www.sanity.io/docs/http-patches#febxf6Fk}
* @beta
*
* @example
* ```ts
Expand Down Expand Up @@ -147,7 +141,6 @@ export function insert<
* @param items - The items to append.
* @returns An `insert` operation for adding a value to the end of an array.
* {@link https://www.sanity.io/docs/http-patches#Cw4vhD88}
* @beta
*
* @example
* ```ts
Expand All @@ -165,7 +158,6 @@ export function append<const Items extends AnyArray<unknown>>(items: Items | Arr
* @param items - The items to prepend.
* @returns An `insert` operation for adding a value to the start of an array.
* {@link https://www.sanity.io/docs/http-patches#refAUsf0}
* @beta
*
* @example
* ```ts
Expand Down Expand Up @@ -205,7 +197,6 @@ export function insertBefore<
* @param indexOrReferenceItem - The index or reference item to insert after.
* @returns An `insert` operation after the provided index or reference item.
* {@link https://www.sanity.io/docs/http-patches#0SQmPlb6}
* @beta
*
* @example
* ```ts
Expand All @@ -230,7 +221,6 @@ export const insertAfter = <
* @returns A `truncate` operation.
* @remarks - This will be converted to an `unset` patch when submitted to the API
* {@link https://www.sanity.io/docs/http-patches#xRtBjp8o}
* @beta
*
* @example
* ```ts
Expand All @@ -254,7 +244,6 @@ export function truncate(startIndex: number, endIndex?: number): TruncateOp {
* @returns A ReplaceOp operation.
* @remarks This will be converted to an `insert`/`replace` patch when submitted to the API
* {@link https://www.sanity.io/docs/http-patches#GnVSwcPa}
* @beta
*
* @example
* ```ts
Expand Down
Loading