searxng v0.0.5

SearXNG Service

A TypeScript service to interact with the SearXNG search engine API. This service allows you to perform searches and retrieve results in various formats with customizable parameters.

Table of Contents

• Installation
• Usage
• Types
  • SearxngCategory
  • SearxngEngine
  • SearxngLocale
  • SearxngPlugin
  • SearxngSearchParameters
  • SearxngSearchResult
  • SearxngSearchResults
• Configuration
• Methods
  • search
• Examples

Installation

npm install searxng

Usage

First, import and instantiate the SearxngService with your configuration:

import { SearxngService, type SearxngServiceConfig } from 'searxng';

const config: SearxngServiceConfig = {
  baseURL: 'https://your-searxng-instance.com',
  defaultSearchParams: {
    format: 'json',
    lang: 'auto',
  },
  defaultRequestHeaders: {
    'Content-Type': 'application/json',
  },
};

const searxngService = new SearxngService(config);

Types

SearxngCategory

export type SearxngCategory =
  | 'general'
  | 'translate'
  | 'web'
  | 'wikimedia'
  | 'images'
  | 'videos'
  | 'news'
  | 'map'
  | 'music'
  | 'lyrics'
  | 'radio'
  | 'it'
  | 'packages'
  | 'q&a'
  | 'repos'
  | 'software_wikis'
  | 'science'
  | 'scientific_publications'
  | 'wikimedia'
  | 'files'
  | 'apps'
  | 'social_media';

SearxngEngine

export type SearxngEngine =
  | '1337x'
  | '9gag'
  // Other engines here
  | 'zlibrary';

SearxngLocale

export type SearxngLocale =
  | 'af'
  | 'ar'
  | 'bg'
  // Other locales here
  | 'zh-Hant-TW';

SearxngPlugin

export type SearxngPlugin =
  | 'Hash_plugin'
  | 'Self_Information'
  // Other plugins here
  | 'Tor_check_plugin';

SearxngSearchParameters

export interface SearxngSearchParameters {
  categories?: SearxngCategory[];
  engines?: SearxngEngine[];
  lang?: 'auto' | SearxngLocale;
  pageno?: number;
  time_range?: 'day' | 'month' | 'year';
  format?: 'json' | 'csv' | 'rss';
  results_on_new_tab?: 0 | 1;
  image_proxy?: boolean;
  autocomplete?: 'google' | 'dbpedia' | 'duckduckgo' | 'mwmbl' | 'startpage' | 'wikipedia' | 'stract' | 'swisscows' | 'qwant';
  safesearch?: 0 | 1 | 2;
  theme?: 'simple';
  enabled_plugins?: SearxngPlugin[];
  disabled_plugins?: SearxngPlugin[];
  enabled_engines?: SearxngEngine[];
  disabled_engines?: SearxngEngine[];
}

SearxngSearchResult

export interface SearxngSearchResult {
  url: string;
  title: string;
  content?: string;
  engine: SearxngEngine;
  parsed_url: string[];
  template: 'default.html' | 'videos.html' | 'images.html';
  engines: SearxngEngine[];
  positions: number[];
  publishedDate?: Date | null;
  thumbnail?: null | string;
  is_onion?: boolean;
  score: number;
  category: SearxngCategory;
  length?: null | string;
  duration?: null | string;
  iframe_src?: string;
  source?: string;
  metadata?: string;
  resolution?: null | string;
  img_src?: string;
  thumbnail_src?: string;
  img_format?: 'jpeg' | 'Culture Snaxx' | 'png';
}

SearxngSearchResults

export interface SearxngSearchResults {
  query: string;
  number_of_results: number;
  results: SearxngSearchResult[];
  answers: string[];
  corrections: string[];
  infoboxes: Array<{
    infobox: string;
    content: string;
    engine: string;
    engines: string[];
  }>;
  suggestions: string[];
  unresponsive_engines: string[];
}

Configuration

export interface SearxngServiceConfig {
  baseURL: string;
  defaultSearchParams?: Partial<SearxngSearchParameters>;
  defaultRequestHeaders?: Record<string, string>;
}

Methods

search

Perform a search with the given input query and optional parameters.

async search(
  input: string,
  params?: Partial<SearxngSearchParameters>,
): Promise<SearxngSearchResults>

• input (string): The search query string.
• params (Partial, optional): Optional additional query parameters.

Returns a promise that resolves to SearxngSearchResults.

Examples

Basic Search

import { SearxngService, type SearxngServiceConfig } from 'searxng';

const config: SearxngServiceConfig = {
  baseURL: 'https://your-searxng-instance.com',
  defaultSearchParams: {
    format: 'json',
    lang: 'auto',
  },
  defaultRequestHeaders: {
    'Content-Type': 'application/json',
  },
};

const searxngService = new SearxngService(config);

async function performSearch() {
  try {
    const results = await searxngService.search('example query');
    console.log(results);
  } catch (error) {
    console.error('Search failed:', error);
  }
}

performSearch();

Search with Parameters

import { SearxngService, type SearxngServiceConfig } from 'searxng';

const config: SearxngServiceConfig = {
  baseURL: 'https://your-searxng-instance.com'
};

const searxngService = new SearxngService(config);

async function performSearchWithParams() {
  const searchParams = {
    categories: ['general', 'web'],
    engines: ['google', 'bing'],
    lang: 'en',
    pageno: 2,
    time_range: 'month',
    format: 'json',
  };

  try {
    const results = await searxngService.search('example query', searchParams);
    console.log(results);
  } catch (error) {
    console.error('Search failed:', error);
  }
}

performSearchWithParams();