Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISearchResult

NPM registry search result structure (subset).

See https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md for full specification.

Hierarchy

  • ISearchResult

Index

Properties

Properties

objects

objects: { flags: { insecure: number; unstable: boolean }; package: { date: string; description: string; keywords: string[]; links: {}; maintainers: IPerson[]; name: string; publisher: IPerson; scope: string; version: string }; score: { detail: { maintenance: number; popularity: number; quality: number }; final: number }; searchScore: number }[]

A collection of search results.

time

time: string

Timestamp of the search result creation.

total

total: number

The total number of objects found by the search.

This can be greater than the number of objects due to pagination of the search results.

Generated using TypeDoc