Hub JS Package

Hub JS Package

  • Users
  • Buckets
  • Threads
  • Textile Docs

›Client

Client

  • Client.withUserAuth() method
  • Client.withKeyInfo() method
  • Client.getToken() method
  • Client.getTokenChallenge() method
  • Client.newDB() method
  • Client.open() method
  • Client.deleteDB() method
  • Client.getDBInfo() method
  • Client.joinFromInfo() method
  • Client.newDBFromAddr() method
  • Client.listen() method
  • Client.listDBs() method
  • Client.newCollection() method
  • Client.newCollectionFromObject() method
  • Client.deleteCollection() method
  • Client.updateCollection() method
  • Client.getCollectionIndexes() method
  • Client.getCollectionInfo() method
  • Client.listCollections() method
  • Client.create() method
  • Client.save() method
  • Client.delete() method
  • Client.find() method
  • Client.findByID() method
  • Client.has() method
  • Client.readTransaction() method
  • Client.writeTransaction() method

WriteTransaction

  • WriteTransaction class
  • WriteTransaction.create() method
  • WriteTransaction.delete() method
  • WriteTransaction.find() method
  • WriteTransaction.findByID() method
  • WriteTransaction.has() method
  • WriteTransaction.save() method
  • WriteTransaction.start() method
  • WriteTransaction.discard() method

ReadTransaction

  • ReadTransaction class
  • ReadTransaction.find() method
  • ReadTransaction.findByID() method
  • ReadTransaction.has() method
  • ReadTransaction.start() method

Types

  • Action enum
  • DBInfo interface
  • Filter interface
  • Query class
  • Update interface
  • Where variable

@textile/hub > Client > delete

Client.delete() method

Deletes an existing model instance from the given store.

Signature:

delete(threadID: ThreadID, collectionName: string, IDs: string[]): Promise<void>;

Parameters

ParameterTypeDescription
threadIDThreadIDthe ID of the database
collectionNamestringThe human-readable name of the model to use.
IDsstring[]An array of instance ids to delete.

Returns:

Promise<void>

Example

Delete any instances that return from a query

import {Client, ThreadID, Where} from '@textile/hub'

interface Astronaut {
  name: string
  missions: number
  _id: string
}

async function deleteBuzz (client: Client, threadID: ThreadID) {
  const query = new Where('name').eq('Buzz')
  const result = await client.find<Astronaut>(threadID, 'astronauts', query)

  if (result.length < 1) return

  const ids = await result.map((instance) => instance._id)
  await client.delete(threadID, 'astronauts', ids)
}

← Client.save() methodClient.find() method →
  • Client.delete() method
  • Parameters
  • Example
Hub JS Package
Docs
Getting StartedThreadDBBuckets
Resources
All DocumentationProject SlackBlog
More
GitHubStar
Follow @textileio