azure-search
Advanced tools
A JavaScript client library for the Azure Search service, which works from either from Node.js or the browser. The module is browserify compatible.
This module call the Azure Search REST API. The documentation for the API is available here.
Use npm:
$ npm install azure-search
If using from node:
var AzureSearch = require('azure-search');
var client = AzureSearch({
url: "https://XXX.search.windows.net",
key:"YYY"
});
If using in the browser:
<html>
<head>
<script src="azure-search.min.js"></script>
</head>
<body>
<script>
var client = AzureSearch({
url: "https://XXX.search.windows.net",
key:"YYYY"
});
</script>
</body>
</html>
Note that from the browser, you must have the
corsOptionsset in the index schema, and onlysearch,suggest,lookupandcountwill work.
A client object can then be used to create, update, list, get and delete indexes:
var schema = {
name: 'myindex',
fields:
[ { name: 'id',
type: 'Edm.String',
searchable: false,
filterable: true,
retrievable: true,
sortable: true,
facetable: true,
suggestions: false,
key: true },
{ name: 'description',
type: 'Edm.String',
searchable: true,
filterable: false,
retrievable: true,
sortable: false,
facetable: false,
suggestions: true,
key: false } ],
scoringProfiles: [],
defaultScoringProfile: null,
corsOptions: null };
// create/update an index
client.createIndex(schema, function(err, schema){
// an error, or the schema object back from the service
});
// get an index
client.getIndex('myindex', function(err, schema){
// an error, or the schema object back from the service
});
// list the indexes
client.listIndexes(function(err, schemas){
// an error, or the list of schemas from the service
});
// get the stats for an index
client.getIndexStats('myindex', function(err, stats){
// an error, or the list of index stats from the service
});
// delete an index
client.deleteIndex('myindex', function(err){
// optional error object
});
You can also add documents to the index, and search it:
var doc1 = {
"id": "document1",
"description": "this is the description of my document"
}
// add documents to an index
client.addDocuments('myindex', [doc1], function(err, results){
// an error, or confirmation of each document being added
});
// retrieve a document from an index
client.lookup('myindex', 'document1', function(){
// an error, or the document
});
// count the number of documents in the index
client.count('myindex', function(err, count){
// an error, or the number of documents in the index
});
// search the index
client.search('myindex', {search: "document", $top: 10}, function(err, results){
// an error, or an array of matching results
});
// suggest results based on partial input
client.suggest('myindex', {search: "doc"}, function(err, results){
// an error, or an array of matching results
});
MIT
FAQs
A client for the Azure Search service
We found that azure-search demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.