JSDoc: Class: BaseSvgScrapingService

Class: BaseSvgScrapingService

(abstract) core/base-service/base-svg-scraping~BaseSvgScrapingService()

Services which scrape data from another SVG badge should extend BaseSvgScrapingService

Source:

Request data from an endpoint serving SVG, parse a value from it and validate against a schema

Name Type Description

attrs

object

Refer to individual attrs

Name	Type	Attributes	Default	Description
`schema`	Joi			Joi schema to validate the response against
`valueMatcher`	RegExp			RegExp to match the value we want to parse from the SVG
`url`	string			URL to request
`options`	object	<optional>	{}	Options to pass to got. See documentation
`httpErrors`	object	<optional>	{}	Key-value map of status codes and custom error messages e.g: `{ 404: 'package not found' }`. This can be used to extend or override the default
`systemErrors`	object	<optional>	{}	Key-value map of got network exception codes and an object of params to pass when we construct an Inaccessible exception object e.g: `{ ECONNRESET: { prettyMessage: 'connection reset' } }`. See got error codes for allowed keys and module:core/base-service/errors~RuntimeErrorProps for allowed values
`logErrors`	Array.<number>	<optional>	[429]	An array of http error codes that will be logged (to sentry, if configured).

Source:

See:

Parsed response

Extract a value from SVG

Name	Type	Attributes	Default	Description
`svg`	string			SVG to parse
`valueMatcher`	RegExp	<optional>	defaultValueMatcher	RegExp to match the value we want to parse from the SVG

Source:

Matched value