Class PageClient

constructor

• new PageClient(config): PageClient

• Parameters

  • config: PageConfig

  Returns PageClient

authToken

config

operationsClient

subscriptionClient

create

• create(projectLocation, projectName, isPublic, withThreads): Promise<Page>

• Publishes a Wonderland Engine Project to the cloud, if a project with the same name already exists, then the project is overwritten else a new project is created.

  Parameters

  • projectLocation: string

    {string} relative or absolute location of your deployment files

  • projectName: string

    {string} your project name

  • isPublic: boolean

    {boolean} whether your project is public or not

  • withThreads: boolean

    {boolean} use threads headers or not for better performance

  Returns Promise<Page>

delete

• delete(projectName): Promise<boolean>

• Delete a deployed page permanently. Warning, this operation is non-revertible and cannot be recovered.

  Parameters

  • projectName: string

    {string}

  Returns Promise<boolean>

get

• get(pageName): Promise<Page>

• Get an existing Wonderland engine page

  Parameters

  • pageName: string

    {string} your page project name

  Returns Promise<Page>

list

• list(listPublic?): Promise<Page[]>

• Lists your own project pages. You can also include the public resources available as well by setting listPublic flag to true

  Parameters

  • listPublic: boolean = false

    {boolean} whether to also list public pages or not

  Returns Promise<Page[]>

modifyApis

• modifyApis(existingPage): Promise<Page>

• Alter the Links between Apis and Pages, by adding/removing a apiPath / apiName pair

  Parameters

  • existingPage: Page

  Returns Promise<Page>

update

• update(projectLocation, projectName, isPublic, withThreads): Promise<Page>

• Updates an existing Wonderland engine project

  Parameters

  • projectLocation: string

    {string} relative or absolute location of your deployment files

  • projectName: string

    {string} your project name

  • isPublic: boolean

    {boolean} whether your project is public or not

  • withThreads: boolean

    {boolean} use threads headers or not for better performance

  Returns Promise<Page>