Users.withUserAuth() method

Creates a new API client instance for accessing the gRPC API using User Group key authentication. This method is recommended for public apps where API secrets need to remain hidden from end users.

Signature:

static withUserAuth(auth: UserAuth | (() => Promise<UserAuth>), options?: WithUserAuthOptions): Users;

Parameters

Parameter	Type	Description
auth	UserAuth \| (() => Promise<UserAuth>)	The UserAuth object.
options	WithUserAuthOptions

Returns:

Users

Example

import { Users, UserAuth } from '@textile/hub'

async function example (userAuth: UserAuth) {
  const users = await Users.withUserAuth(userAuth)
}