Atlas

Appearance

Interface: Client ​

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:33

Properties ​

config ​

config: object

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:35

endpoint ​

endpoint: string

forwardeduseragent ​

forwardeduseragent: string

impersonateuseremail ​

impersonateuseremail: string

impersonateuserid ​

impersonateuserid: string

impersonateuserphone ​

impersonateuserphone: string

jwt ​

jwt: string

key ​

key: string

locale ​

locale: string

project ​

project: string

selfSigned ​

selfSigned: boolean

session ​

session: string

headers ​

headers: Headers

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:48

Methods ​

addHeader() ​

addHeader(header, value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:75

Add header

Parameters ​

string

value ​

string

Returns ​

this

call() ​

call(method, url, headers?, params?, responseType?): Promise<any>

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:180

Parameters ​

method ​

string

url ​

URL

headers? ​

Headers

params? ​

Payload

responseType? ​

string

Returns ​

Promise<any>

chunkedUpload() ​

chunkedUpload(method, url, headers, originalPayload, onProgress): Promise<any>

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:177

Parameters ​

method ​

string

url ​

URL

headers ​

Headers | undefined

originalPayload ​

Payload | undefined

onProgress ​

(progress) => void

Returns ​

Promise<any>

getHeaders() ​

getHeaders(): Headers

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:84

Get Headers

Returns a copy of the current request headers, including any authentication headers. Handle with care.

Returns ​

Headers

ping() ​

ping(): Promise<string>

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:178

Returns ​

Promise<string>

prepareRequest() ​

prepareRequest(method, url, headers?, params?): object

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:173

Parameters ​

method ​

string

url ​

URL

headers? ​

Headers

params? ​

Payload

Returns ​

object

options ​

options: RequestInit

uri ​

uri: string

redirect() ​

redirect(method, url, headers?, params?): Promise<string>

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:179

Parameters ​

method ​

string

url ​

URL

headers? ​

Headers

params? ​

Payload

Returns ​

Promise<string>

setEndpoint() ​

setEndpoint(endpoint): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:58

Set Endpoint

Your project endpoint

Parameters ​

endpoint ​

string

Returns ​

this

setForwardedUserAgent() ​

setForwardedUserAgent(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:142

Set ForwardedUserAgent

The user agent string of the client that made the request

Parameters ​

value ​

string

string

Returns ​

this

setImpersonateUserEmail() ​

setImpersonateUserEmail(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:162

Set ImpersonateUserEmail

Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.

Parameters ​

value ​

string

string

Returns ​

this

setImpersonateUserId() ​

setImpersonateUserId(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:152

Set ImpersonateUserId

Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.

Parameters ​

value ​

string

string

Returns ​

this

setImpersonateUserPhone() ​

setImpersonateUserPhone(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:172

Set ImpersonateUserPhone

Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins. Internal audit logs still attribute actions to the original impersonator and record the impersonated target only in internal audit payload data.

Parameters ​

value ​

string

string

Returns ​

this

setJWT() ​

setJWT(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:114

Set JWT

Your secret JSON Web Token

Parameters ​

value ​

string

string

Returns ​

this

setKey() ​

setKey(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:104

Set Key

Your secret API key

Parameters ​

value ​

string

string

Returns ​

this

setLocale() ​

setLocale(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:122

Set Locale

Parameters ​

value ​

string

string

Returns ​

this

setProject() ​

setProject(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:94

Set Project

Your project ID

Parameters ​

value ​

string

string

Returns ​

this

setSelfSigned() ​

setSelfSigned(selfSigned): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:66

Set self-signed

Parameters ​

selfSigned ​

boolean

Returns ​

this

setSession() ​

setSession(value): this

Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/client.d.mts:132

Set Session

The user session to authenticate with

Parameters ​

value ​

string

string

Returns ​

this