Class Turbine

Hierarchy

Turbine

Index

Constructors

Properties

Methods

createProject deleteProject getProject getProjects search

Constructors

constructor

new Turbine(apiKey, baseUrl?): Turbine
Parameters
- apiKey: string
- Optional baseUrl: string
Returns Turbine
- Defined in turbine.ts:8

Properties

`Private` axios

axios: Axios

Methods

createProject

createProject(config): Promise<string>
Parameters
- config: ProjectConfig
Returns Promise<string>
- Defined in turbine.ts:17

deleteProject

deleteProject(projectId): Promise<void>
Parameters
- projectId: string
Returns Promise<void>
- Defined in turbine.ts:32

getProject

getProject(projectId): Promise<Project>
Parameters
- projectId: string
Returns Promise<Project>
- Defined in turbine.ts:22

getProjects

getProjects(): Promise<Project[]>
Returns Promise<Project[]>
- Defined in turbine.ts:27

search

search(projectId, query, limit?): Promise<SearchResult[]>
Parameters
- projectId: string
- query: string
- limit: number = 10
Returns Promise<SearchResult[]>
- Defined in turbine.ts:36

Generated using TypeDoc