Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@findify/sdk
Advanced tools
Readme
The Findify JavaScript SDK is a lightweight, promise based interface to to Findify v3 search API that works in both nodejs and browser environments.
The full documentation can be found here: https://findify.readme.io/v3/reference#js-sdk-introduction
For release notes, see the CHANGELOG.
To use the SDK in the browser, simply add the following script tag to your HTML pages:
<script src="https://cdn.jsdelivr.net/npm/@findify/sdk@latest/dist/findify-sdk.js></script>
Install the SDK using npm:
$ npm install --save @findify/sdk
or yarn
$ yarn add @findify/sdk
The Findify SDK for JavaScript bundles TypeScript definition files for use in TypeScript projects and to support tools that can read .d.ts
files.
Our goal is to keep these TypeScript definition files updated with each release for any public api.
var FindifySDK = require('@findify/sdk');
// First, you need to initialize library:
var client = FindifySDK.init({
key: 'your_api_key',
// If you are using this library on a frontend, it will be convenient for you to provide user once on initialization.
// You can get user object, using `findify-analytics` library, or by manually getting data from cookies:
user: {
uid: 'user_id',
sid: 'session_id'
}
});
// After library initialized, we can send requests to server with `client` instance. Let's perform autocomplete request:
client.send({
type: 'autocomplete',
params: {
q: 'Red jacket',
// If you are using this library on server, you will need to deal with multiple users objects.
// In this case, you need to provide `user` object on each request. If you provided `user` on init, it will be overrided:
user: {
uid: 'user_id',
sid: 'session_id'
}
}
}).then(function(response) {
// `response` variable will contain all response data from server, which could be later provided to the view layer.
});
See examples/ for working examples of how the SDK can be used in a few different environments.
We will try to follow semver as close as possible. That means bug fixes will be patch releases (1.0.1 -> 1.0.2), additional functionality like new endpoints will be minor releases (1.0.1 -> 1.1.0) and breaking changes to both the library and the API endpoints it hits, will be major releases (1.0.1 -> 2.0.0).
We use the GitHub issues for tracking bugs and feature requests.
findify-sdk
If you encounter a bug with the Findify SDK for JavaScript we would like to hear about it. Search the existing issues and try to make sure your problem doesn’t already exist before opening a new issue. It’s helpful if you include the version of the SDK, Node.js or browser environment and OS you’re using. Please include a stack trace and reduced repro case when appropriate, too.
The GitHub issues are intended for bug reports and feature requests. For help and questions with using the Findify SDK for JavaScript please make use of the resources listed in the Getting help section.
Please see CONTRIBUTING.md for information on how to contribute, setup the development environment and run tests.
FAQs
Findify search API client
The npm package @findify/sdk receives a total of 122 weekly downloads. As such, @findify/sdk popularity was classified as not popular.
We found that @findify/sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.