Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TaskAdapterInstance

An instance of a TaskAdapterFactory

Hierarchy

Index

Properties

Properties

client

client: any

A pre-configured got object

create

create: function

POST an item of a type to Todoist

param
returns

Type declaration

    • (data: any): Promise<any>

    • Parameters

      • data: any

      Returns Promise<any>

find

find: function

Find a task by it's id.

param
returns

A task instance

Type declaration

    • (id: number): Promise<Task>

    • Parameters

      • id: number

      Returns Promise<Task>

findAll

findAll: function

Get all tasks

returns

All tasks

Type declaration

    • (): Promise<Task[]>

    • Returns Promise<Task[]>

getRelationships

getRelationships: function

Retrieve a tasks labels an projects by id.

param
param
returns

Type declaration

query

query: function

Returns items of a type based on a query. Returns all items when qeurr is falsy.

param
returns

Type declaration

    • (query: string, key: string): Promise<any>

    • Parameters

      • query: string
      • key: string

      Returns Promise<any>

remove

remove: function

API call to delete a single item.

param
returns

Type declaration

    • (id: number): Promise<any>

    • Parameters

      • id: number

      Returns Promise<any>

token

token: string

The API token.

type

type: "task" | "project" | "label"

The resource type.

update

update: function

POST an item of a type to Todoist replacing a known value

param
param
returns

Type declaration

    • (id: number, data: any): Promise<any>

    • Parameters

      • id: number
      • data: any

      Returns Promise<any>

uri

uri: string

The todoist api url

Generated using TypeDoc