berkeleybop/bbop-response-golr

Name: bbop-response-golr

Owner: Berkeley BOP

Description: Response type and API for handling the returns from a GOlr instance in a standard way.

Created: 2015-11-17 05:34:10.0

Updated: 2016-03-29 00:16:36.0

Pushed: 2016-11-01 00:10:48.0

Homepage: null

Size: 25

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

bbop-response-golr

Overview

Response type and API for handling the responses from a GOlr instance (Solr server with a structured schema) in a standard way.

In addition to the base functionality provided by bbop-rest-response, this class adds a ton of extra functionality for checking responses and accessing different parts of the return document in a consistent way. For a (small) sample of methods:

• total_documents, start_document, end_document (document counting)
• paging_previous_p, paging_next_p (paging handling)
• documents, get_doc (general document access)
• get_doc_field, get_doc_label (document field access)
• much more…

This is a subclass of bbop-rest-response. For more detailed information, please see the unit tests.

Availability

GitHub

NPM

API

index