npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sync_gateway

v1.4.7

Published

Documentation_for_the_Sync_Gateway_Public_REST_API__This_page_is_generated_from_the_Sync_Gateway_Public_Swagger_spec_the_exact_same_information_is_also_available_at__developer_couchbase_commobileswaggersync_gateway_public_httpdeveloper_couchbase_commobile

Downloads

8

Readme

sync_gateway

SyncGateway - JavaScript client for sync_gateway Documentation for the Sync Gateway Public REST API. This page is generated from the Sync Gateway Public Swagger spec, the exact same information is also available at developer.couchbase.com/mobile/swagger/sync-gateway-public. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.4
  • Package version: 1.4
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install sync_gateway --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var SyncGateway = require('sync_gateway');

var defaultClient = SyncGateway.ApiClient.instance;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['Cookie'] = "Token"

var api = new SyncGateway.AttachmentApi()

var db = "db_example"; // {String} Database name

var doc = "doc_example"; // {String} Document ID

var attachment = "attachment_example"; // {String} Attachment name

var opts = { 
  'rev': "rev_example" // {String} Revision identifier of the parent revision the new one should replace. (Not used when creating a new document.)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dbDocAttachmentGet(dbdocattachment, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:4984/

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- SyncGateway.AttachmentApi | dbDocAttachmentGet | GET /{db}/{doc}/{attachment} | Get attachment SyncGateway.AttachmentApi | dbDocAttachmentPut | PUT /{db}/{doc}/{attachment} | Add or update document SyncGateway.AuthApi | dbOidcCallbackGet | GET /{db}/_oidc_callback | OpenID Connect Authentication callback. SyncGateway.AuthApi | dbOidcChallengeGet | GET /{db}/_oidc_challenge | OpenID Connect Authentication. SyncGateway.AuthApi | dbOidcGet | GET /{db}/_oidc | OpenID Connect Authentication. SyncGateway.AuthApi | dbOidcRefreshGet | GET /{db}/_oidc_refresh | OpenID Connect refresh. SyncGateway.DatabaseApi | dbAllDocsGet | GET /{db}/_all_docs | All docs SyncGateway.DatabaseApi | dbAllDocsPost | POST /{db}/_all_docs | All docs SyncGateway.DatabaseApi | dbBulkDocsPost | POST /{db}/_bulk_docs | Bulk docs SyncGateway.DatabaseApi | dbBulkGetPost | POST /{db}/_bulk_get | Bulk get SyncGateway.DatabaseApi | dbChangesGet | GET /{db}/_changes | Changes SyncGateway.DatabaseApi | dbChangesPost | POST /{db}/_changes | Changes SyncGateway.DatabaseApi | dbGet | GET /{db}/ | Database info SyncGateway.DocumentApi | dbDocDelete | DELETE /{db}/{doc} | Delete document SyncGateway.DocumentApi | dbDocGet | GET /{db}/{doc} | Get document SyncGateway.DocumentApi | dbDocPut | PUT /{db}/{doc} | Create or update document SyncGateway.DocumentApi | dbLocalLocalDocDelete | DELETE /{db}/_local/{local_doc} | Delete a local document SyncGateway.DocumentApi | dbLocalLocalDocGet | GET /{db}/_local/{local_doc} | Get local doc SyncGateway.DocumentApi | dbLocalLocalDocPut | PUT /{db}/_local/{local_doc} | Create or update a local document SyncGateway.DocumentApi | post | POST /{db}/ | Create document SyncGateway.QueryApi | dbDesignDdocViewViewGet | GET /{db}/_design/{ddoc}/_view/{view} | Query a view SyncGateway.ServerApi | rootGet | GET / | Server SyncGateway.SessionApi | dbSessionDelete | DELETE /{db}/_session | Delete a user session SyncGateway.SessionApi | dbSessionPost | POST /{db}/_session | Create a user session

Documentation for Models

Documentation for Authorization

apiKey

  • Type: API key
  • API key parameter name: Cookie
  • Location: HTTP header

basicAuth

  • Type: HTTP basic authentication