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

node-basex

v0.0.3

Published

A BaseX REST Client for Node.js

Downloads

6

Readme

BaseX REST Client

Build Status

BaseX REST Client provides an easy way to query a BaseX (XML Database) HTTP server through its REST API using the POST method.

Getting Started

Installation

$ npm install node-basex

Usage

var basex = require('node-basex');

var client = new basex.Client({});
var query = {
  text: 'for $i in //example return $i'
};

client.query(query, function (data) {
  console.log(data); // Response data
});

In Depth

The BaseX REST API documentation contains information on how a POST query should be structured for communicating with Basex and will help clarify the various options specified below.

Creating the REST Client

The BaseX REST Client is created by providing an object containing all the options for the connection. The options are option and include host, port, path, username, and password. Any option omitted will use the default BaseX value.

var basex = require('node-basex');
var client = new basex.Client({
  host: 'localhost',
  port: 8984,
  path: '/rest/mydatabase',
  username: 'admin',
  password: 'admin'
});

Note: An empty object is required for the options even if you are using defaults

Queries

Queries follow the BaseX REST POST Schema and can consist of text, context, parameter, variable and option elements.

Text

The text element is used to specify the query operation.

var query = {
  text: 'for $i in //example return $i'
};

Context

The context parameter is used to provide an initial XML context node.

var query = {
  context: 'context'
};

Options

Options are applied before the actual query operation (text) is performed.

var query = {
  options: [
    {key: 'option1', value: 1},
    {key: 'option2', value: 2}
  ]
};

Variables

Variables allow for external variables to be set that can be referenced from the text element.

var query = {
  variables: [
    {key: 'var1', value: 1},
    {key: 'var2', value: 2}
  ]
};

Running the Query

When the query is run, any response data will be returned via the callback so long as the BaseX HTTP server is running.

client.query(query, function (data) {
  // Response data can be null
});

Running Tests

$ npm install -g gulp mocha
$ npm test