UNPKG

837 BTypeScriptView Raw
1import React from 'react';
2import algoliasearch from 'algoliasearch';
3export interface IPackage {
4 objectID: string;
5 name: string;
6 version: string;
7 description: string;
8 repository?: IPackageRepository;
9 owner: IPackageOwner;
10 humanDownloadsLast30Days: string;
11}
12export interface IPackageRepository {
13 url: string;
14}
15export interface IPackageOwner {
16 name: string;
17 email?: string;
18 avatar: string;
19 link: string;
20}
21/**
22 *
23 * Performs a search for the specified query and returns information
24 * displayed in the UI.
25 *
26 * @param query
27 * @param limit
28 */
29export declare const search: (query: string, page?: number) => Promise<algoliasearch.Response<IPackage>>;
30export declare type WithSearchContext<X> = X & {
31 hits: IPackage[];
32};
33export declare const SearchContext: React.Context<IPackage[]>;