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 > withKeyInfo

Client.withKeyInfo() method

Create a new gRPC client instance from a supplied key and secret

Signature:

static withKeyInfo(key: KeyInfo, host?: string, debug?: boolean): Promise<Client>;

Parameters

ParameterTypeDescription
keyKeyInfoThe KeyInfo object containing {key: string, secret: string, type: 0}. 0 === User Group Key, 1 === Account Key
hoststringThe remote gRPC host to connect with. Should be left as default.
debugbooleanWhether to run in debug mode. Defaults to false.

Returns:

Promise<Client>

Example

import {KeyInfo, Client} from '@textile/hub'

async function create (keyInfo: KeyInfo) {
  return await Client.withKeyInfo(keyInfo)
}

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