Interface ResourcesApi

interface ResourcesApi {
    "[iterator]"(): IterableIterator<BlueprintResource<string>>;
    all(): BlueprintResource<string>[];
    cors(name: string): BlueprintResource<string> | undefined;
    dataset(name: string): BlueprintResource<string> | undefined;
    function(
        name: string,
    ): BlueprintResource<`sanity.function.${string}`> | undefined;
    project(name: string): BlueprintResource<string> | undefined;
    role(name: string): BlueprintResource<string> | undefined;
    webhook(name: string): BlueprintResource<string> | undefined;
    (name: string): BlueprintResource<string> | undefined;
}

ResourcesApi(name: string): BlueprintResource<string> | undefined
Cross-type lookup by name: context.resources('my-proj').
Parameters
- name: string
Returns BlueprintResource<string> | undefined
- Defined in types/resources.ts:12

Index

Methods

[iterator] all cors dataset function project role webhook

Methods

[iterator]

"[iterator]"(): IterableIterator<BlueprintResource<string>>
Iterate every resource: for (const r of context.resources).

Returns IterableIterator<BlueprintResource<string>>
- Defined in types/resources.ts:16

all

all(): BlueprintResource<string>[]
Flat array of every resource across types.

Returns BlueprintResource<string>[]
- Defined in types/resources.ts:14

cors

cors(name: string): BlueprintResource<string> | undefined
Type specific lookup by name: context.cors('my-cors')
Parameters
- name: string
Returns BlueprintResource<string> | undefined
- Defined in types/resources.ts:18

dataset

dataset(name: string): BlueprintResource<string> | undefined
Parameters
- name: string
Returns BlueprintResource<string> | undefined
- Defined in types/resources.ts:19

function

function(
name: string,
): BlueprintResource<`sanity.function.${string}`> | undefined
Parameters
- name: string
Returns BlueprintResource<`sanity.function.${string}`> | undefined
- Defined in types/resources.ts:20

project

project(name: string): BlueprintResource<string> | undefined
Parameters
- name: string
Returns BlueprintResource<string> | undefined
- Defined in types/resources.ts:21

role

role(name: string): BlueprintResource<string> | undefined
Parameters
- name: string
Returns BlueprintResource<string> | undefined
- Defined in types/resources.ts:22

webhook

webhook(name: string): BlueprintResource<string> | undefined
Parameters
- name: string
Returns BlueprintResource<string> | undefined
- Defined in types/resources.ts:23