Skip to content

Add documentation for getPrimaryRoute #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
signalwerk wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for getPrimaryRoute #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,26 @@ config.onProduction();
>
> It is recommended that you update your projects to use `onDedicated` as soon as possible, as `onEnterprise` will be removed in a future version of this library.


### Get Primary Route
```js
config.getPrimaryRoute()
```
Will return an object of the primary route according to [`.platform/routes.yaml`](https://docs.platform.sh/configuration/routes.html).

#### Example
```js
{
primary: true
id: null
attributes: {}
type: "upstream"
upstream: "site1"
original_url: "https://site1.{default}/"
url: "https://site1.test-t6dnbai-abcdef1234567.us-2.platformsh.site/"
}
```

### Read environment variables

The following magic properties return the corresponding environment variable value. See the [Platform.sh documentation](https://docs.platform.sh/development/variables.html) for a description of each.
Expand Down