Class ProjectsApi

Hierarchy (View Summary)

ApiGroup<ProjectApiEvents>
- ProjectsApi

Index

Constructors

Properties

client eip712 listeners provider

Accessors

availableModels

Methods

create emit estimateCost off on once waitForModels

Constructors

constructor

new ProjectsApi(config: ApiConfig): ProjectsApi
Parameters
- config: ApiConfig
Returns ProjectsApi
Overrides ApiGroup.constructor
- Defined in Projects/index.ts:28

Properties

`Protected`client

client: ApiClient

`Protected`eip712

eip712: EIP712Helper

`Protected`listeners

listeners: {
    availableModels?: (data: AvailableModel[]) => void[];
    job?: (data: JobEvent) => void[];
    project?: (data: ProjectEvent) => void[];
} = {}

`Protected`provider

provider: AbstractProvider

Accessors

availableModels

get availableModels(): AvailableModel[]
Returns AvailableModel[]
- Defined in Projects/index.ts:24

Methods

create

create(data: ProjectParams): Promise<Project>
Send new project request to the network. Returns project instance which can be used to track progress and get resulting images.
Parameters
- data: ProjectParams
Returns Promise<Project>
- Defined in Projects/index.ts:270

`Protected`emit

emit<T extends keyof ProjectApiEvents>(
event: T,
data: ProjectApiEvents[T],
): void
Dispatch an event to all listeners
Type Parameters
- T extends keyof ProjectApiEvents
Parameters
- event: T
- data: ProjectApiEvents[T]
Returns void
Inherited from ApiGroup.emit
- Defined in lib/TypedEventEmitter.ts:57

estimateCost

estimateCost(
__namedParameters: EstimateRequest,
): Promise<{ token: string; usd: string }>
Estimate project cost
Parameters
- __namedParameters: EstimateRequest
Returns Promise<{ token: string; usd: string }>
- Defined in Projects/index.ts:305

off

off<T extends keyof ProjectApiEvents>(
event: T,
listener: (data: ProjectApiEvents[T]) => void,
): void
Remove an event listener
Type Parameters
- T extends keyof ProjectApiEvents
Parameters
- event: T
- listener: (data: ProjectApiEvents[T]) => void
Returns void
Inherited from ApiGroup.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends keyof ProjectApiEvents>(
event: T,
listener: (data: ProjectApiEvents[T]) => void,
): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends keyof ProjectApiEvents
Parameters
- event: T
- listener: (data: ProjectApiEvents[T]) => void
Returns () => void
Inherited from ApiGroup.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends keyof ProjectApiEvents>(
event: T,
listener: (data: ProjectApiEvents[T]) => void,
): () => void
Add an event listener that will be called only once
Type Parameters
- T extends keyof ProjectApiEvents
Parameters
- event: T
- listener: (data: ProjectApiEvents[T]) => void
Returns () => void
Inherited from ApiGroup.once
- Defined in lib/TypedEventEmitter.ts:32

waitForModels

waitForModels(timeout?: number): Promise<AvailableModel[]>
Wait for available models to be received from the network. Useful for scripts that need to run after the models are loaded.
Parameters
- timeout: number = 10000
  timeout in milliseconds until the promise is rejected
Returns Promise<AvailableModel[]>
- Defined in Projects/index.ts:246