@switstack/swittest-api-ts
    Preparing search index...

    Function ParserApiFactory

    • ParserApi - factory interface

      Parameters

      • Optionalconfiguration: Configuration
      • OptionalbasePath: string
      • Optionalaxios: AxiosInstance

      Returns {
          listTags(
              options?: RawAxiosRequestConfig,
          ): AxiosPromise<{ [key: string]: string }>;
          parseLog(
              requestParameters: ParserApiParseLogRequest,
              options?: RawAxiosRequestConfig,
          ): AxiosPromise<TestFileInfo>;
          parseTag(
              requestParameters: ParserApiParseTagRequest,
              options?: RawAxiosRequestConfig,
          ): AxiosPromise<ParsedTag>;
          parseTlv(
              requestParameters: ParserApiParseTlvRequest,
              options?: RawAxiosRequestConfig,
          ): AxiosPromise<object>;
      }

      • listTags: function
        • List all supported tags and their names.

          Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<{ [key: string]: string }>

      • parseLog: function
        • Accepts an uploaded HTML file and returns a test schema and vCard from it.

          Parameters

          • requestParameters: ParserApiParseLogRequest

            Request parameters.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<TestFileInfo>

      • parseTag: function
        • Parse a specific tag and returns all the information that can be extracted from it.

          Parameters

          • requestParameters: ParserApiParseTagRequest

            Request parameters.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<ParsedTag>

      • parseTlv: function
        • Parse a TLV string and return a dict of the tag's name and value(s).

          Parameters

          • requestParameters: ParserApiParseTlvRequest

            Request parameters.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<object>