kernl API
    Preparing search index...

    Function parseLocator

    • Parses a locator string into its scheme and scheme-specific fields.

      Magnet links yield infoHash (lowercase hex), name, trackers and webSeeds. NZB locators (nzb:// wrapping an encoded web URL, or a web URL ending in .nzb) yield url and name. Soulseek locators yield user and path. Mail locators yield address, addresses, subject and body. Web URLs yield origin, host and path. Any other well-formed scheme yields no fields.

      Parameters

      • uri: string

        The locator string.

      Returns Locator

      The parsed locator.

      invalid:locator for strings that are not a locator, invalid:magnet-missing-hash for magnets without an info hash.

      const locator = parseLocator('magnet:?xt=urn:btih:' + 'ab'.repeat(20) + '&dn=Film');
      locator.scheme; // 'magnet'
      locator.fields.name; // 'Film'