Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@based/client

Package Overview
Dependencies
Maintainers
7
Versions
139
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@based/client

Based client

  • 6.7.0
  • npm
  • Socket score

Version published
Weekly downloads
608
increased by55.9%
Maintainers
7
Weekly downloads
 
Created
Source

@based/client

Based client

import based from '@based/client'

// Create client
const client = based({
  env: 'myEnv',
  org: 'myOrg',
  project: 'myProject',
})

client.once('connect', (isConnected) => {
  console.info('connect', isConnected)
})

// Authenticate and use localStorage or a file in node
const authState = await client.setAuthState({
  token,
  persistent: true,
})

// Call a function
await client.call('db:update-schema', {
  languages: ['en'],
  types: {
    thing: {
      fields: {
        name: { type: 'string' },
      },
    },
  },
})

// Get data once
const data = await client.query('db', { $id: 'fwe2233', title: true }).get()

// Get updates, persistent stores results in localStorage
const unsubscribe = client
  .query('db', { $id: 'fwe2233', title: true }, { persistent: true })
  .subscribe((data) => console.log(data))

// Channels are stateless streams
const unsubscribeChannel = client
  .channel('events', { type: 'page-view' })
  .subscribe((event) => console.log(event))

client.channel('events', { type: 'page-view' }).publish({ id: 'mypage' })

FAQs

Package last updated on 05 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc