Logos DX
    Preparing search index...

    Class ParamsManager<P>

    Manages URL parameters for FetchEngine with event emission.

    Wraps PropertyStore with FetchEngine-specific event emission. Pulls initial params and validation from engine options.

    // Access via engine.params
    engine.params.set('apiKey', 'abc123');
    engine.params.set({ page: '1', limit: '10' });

    // Method-specific params
    engine.params.set('format', 'json', 'GET');

    // Remove params
    engine.params.remove('apiKey');
    engine.params.remove(['page', 'limit']);

    // Check if param exists
    if (engine.params.has('apiKey')) { ... }

    // Get resolved params for a request
    const params = engine.params.resolve('GET', { extra: 'value' });

    Type Parameters

    • P = unknown

      Params type

    Index

    Constructors

    Accessors

    Methods

    • Check if a param exists globally or for a specific method.

      Parameters

      • key: string
      • Optionalmethod: string

      Returns boolean

      if (engine.params.has('apiKey')) {
      console.log('API key is set');
      }
    • Remove a param globally or for a specific method.

      Parameters

      • key: string
      • Optionalmethod: string

      Returns void

      engine.params.remove('apiKey');
      engine.params.remove('format', 'GET');
    • Remove multiple params globally or for a specific method.

      Parameters

      • keys: string[]
      • Optionalmethod: string

      Returns void

      engine.params.remove(['page', 'limit']);
      engine.params.remove(['format'], 'GET');
    • Set a param value globally or for a specific method.

      Parameters

      • key: string
      • value: string
      • Optionalmethod: string

      Returns void

      engine.params.set('apiKey', 'abc123');
      engine.params.set('format', 'json', 'GET');
    • Set multiple param values globally or for a specific method.

      Parameters

      Returns void

      engine.params.set({ page: '1', limit: '10' });
      engine.params.set({ format: 'json' }, 'GET');