Class ObservableProjectsClient

Observable version of the ProjectsClient. All methods return RxJS Observables instead of Promises.

Example

client.projects.list().subscribe(projects => {
  console.log('Available projects:', projects)
})

Constructors

constructor

Methods

getById list

Constructors

constructor

Methods

getById

  • getById(projectId: string): Observable<SanityProject>

    Fetch a project by project ID

    Parameters

    • projectId: string

      ID of the project to fetch

    Returns Observable<SanityProject>

list

  • list(options?: { includeMembers?: true }): Observable<SanityProject[]>

    Fetch a list of projects the authenticated user has access to.

    Parameters

    • Optionaloptions: { includeMembers?: true }

      Options for the list request

      • OptionalincludeMembers?: true

        Whether to include members in the response (default: true)

    Returns Observable<SanityProject[]>

  • list(
        options?: { includeMembers?: false },
    ): Observable<Omit<SanityProject, "members">[]>

    Fetch a list of projects the authenticated user has access to.

    Parameters

    • Optionaloptions: { includeMembers?: false }

      Options for the list request

      • OptionalincludeMembers?: false

        Whether to include members in the response (default: true)

    Returns Observable<Omit<SanityProject, "members">[]>

Settings

Member Visibility

On This Page

Constructors
Methods