Class default

An object representing a SpeedCurve site

Hierarchy

default

Index

Constructors

Properties

name siteId urls

Methods

toJSON fromApiResponse

Constructors

constructor

new default(siteId: number, name: string, urls: default[]): default
Parameters
- siteId: number
- name: string
- urls: default[]
Returns default
- Defined in model/site.ts:13

Properties

name

name: string

siteId

siteId: number

urls

urls: default[]

Methods

toJSON

toJSON(key: string): default | Omit<default, "urls">
JSON stringification on a Site results in circular references, since each of the URLs have a "site" property referencing the Site. To get around this, Site detects when it has been nested under a "site" key and removes its own "urls" property.
Parameters
- key: string
Returns default | Omit<default, "urls">
- Defined in model/site.ts:42

`Static` fromApiResponse

fromApiResponse(response: SiteApiResponse): default
Build a new Site object from a https://api.speedcurve.com/#get-site-details-and-settings|/v1/sites API response object
Parameters
- response: SiteApiResponse
Returns default
- Defined in model/site.ts:23

Generated using TypeDoc