
Product
Introducing Repository Labels and Security Policies
Socket is introducing a new way to organize repositories and apply repository-specific security policies.
@attraqt/search
Advanced tools
Use `@attraqt/search` to search through items using the XO platform.
Use @attraqt/search
to search through items using the XO platform.
npm install --save @attraqt/search
import { search } from '@attraqt/search';
search.init({
token: 'SEARCH_API_TOKEN'
});
const searchResponse = await search.query('T-Shirt', {
offset: 10,
limit: 30,
filter: 'price < 50'
});
console.log(searchResponse.items);
console.log(searchResponse.metadata);
const suggestResponse = await xo.search.suggest('T-Shirt', {
filter: 'price < 50',
groupBy: {
attribute: 'kind',
count: 10,
values: ['product', 'shops', 'ads']
}
});
console.log(suggestResponse.items);
console.log(suggestResponse.metadata);
const autocompleteResponse = await xo.search.autocomplete('T-Shirt', {
numberOfSuggestions: 5
});
console.log(autocompleteResponse.suggestions);
console.log(autocompleteResponse.metadata);
Method | Argument(s) | Result | Description |
---|---|---|---|
init | options: SearchInitOptions | void | Initializes the search client |
query | query: string , options?: SearchItemOptions , requestOptions?: SearchRequestOptions | Promise<SearchResponse> | Searches for items |
suggest | query: string , options?: SearchGroupOptions , requestOptions?: SearchRequestOptions | Promise<SearchResponse> | Suggest and group a selection of items |
autocomplete | query: string , options?: AutocompleteOptions , requestOptions?: SearchRequestOptions | Promise<AutocompleteResponse> | Autocomplete a query, and get suggestions |
Properties to initialize the search component.
Option | Type | Description |
---|---|---|
token | string | Required: Your unique token provided by Attraqt |
region ? | Region | Optional: Region where you need to use the service. If an invalid or no region is selected then EU will be used. |
All options are optional.
Option | Type | Description |
---|---|---|
limit | number | Pagination: Size of a page |
offset | number | Pagination: Index of the first item to fetch |
filter | string | Filter query string |
sortBy | SortOptions[] | Sort options, evaluated in order of appearance |
facets | FacetRequestOptions[] | Facets filters to apply to the query |
customResponseMask | string | Custom response mask. Allows to fetch only specific field from the catalog |
disable | DisableOptions[] | Features to disable for this query |
All options are optional.
Option | Type | Description |
---|---|---|
filter | string | Filter query string |
sortBy | SortOptions[] | Sort options, evaluated in order of appearance |
customResponseMask | string | Custom response mask. Allows to fetch only specific field from the catalog |
groupBy | GroupOptions | Group result by an attribute and its specified values |
All options are optional.
Option | Type | Description |
---|---|---|
numberOfSuggestions | number | Number of suggestions to get. Default is 10 |
The following table lists the name and code of each Region.
Region name | Code |
---|---|
Australia | AU |
Europe | EU |
United States | US |
FAQs
Use `@attraqt/search` to search through items using the XO platform.
The npm package @attraqt/search receives a total of 337 weekly downloads. As such, @attraqt/search popularity was classified as not popular.
We found that @attraqt/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.
Product
Socket is introducing a new way to organize repositories and apply repository-specific security policies.
Research
Security News
Socket researchers uncovered malicious npm and PyPI packages that steal crypto wallet credentials using Google Analytics and Telegram for exfiltration.
Product
Socket now supports .NET, bringing supply chain security and SBOM accuracy to NuGet and MSBuild-powered C# projects.