textiot/js-http-client/src/models/index.ts

A framework for building web and native (IoT) Dapps on the IPFS network

// Protobuf types created from go-textile using:
// yarn add https://github.com/carsonfarmer/protoc-gen-jsonpb-ts
// cd pb/protos
// protoc --plugin=../../node_modules/protoc-gen-jsonpb-ts/bin/protoc-gen-jsonpb-ts --jsonpb-ts_out=. *.proto
export * from './model_pb'
export * from './cafe_service_pb'
export * from './message_pb'
export * from './query_pb'
export * from './threads_service_pb'
export * from './view_pb'
export * from './mobile_pb'

/**
 * The options object for the client object
 * @property url The base URL of the Textile node API (default 'http://127.0.0.1')
 * @property port The port of the Textile node API (default 40600)
 * @property version The Textile node API version (default 0)
 */
export interface TextileOptions {
  url?: string
  port?: number
  version?: number
}
/**
 * The options object for the client object
 * @property url The base URL of the Textile node API (default 'http://127.0.0.1')
 * @property port The port of the Textile node API (default 40600)
 * @property version The Textile node API version (default 0)
 */
export interface ApiOptions {
  url: string
  port: number
  version: number
}

/**
 * Additional options to control search queries
 * @typedef {Object} QueryOptions
 * @param local Whether to only search local contacts
 * @param remote Whether to only search remote contacts
 * @param limit Stops searching after 'limit' results are found
 * @param wait Stops searching after ‘wait’ seconds have elapsed
 */
export interface QueryOptions {
  local?: boolean
  remote?: boolean
  limit?: number
  wait?: number
}

export type KeyValue = Record<string, string | number | boolean>

/**
 * Version information for Textile nodes
 * @property cafe_version The API version of the Cafe
 * @property node_version The release version of the running node
 */
export interface Versions {
  cafe_version: string
  node_version: string
}