Brunobkr/llama.cpp_AlgMor24_github

1# @webcontainer/env2 3> ⚠️ Important ⚠️4>5> We strongly recommend that you update to version `1.1.0` or greater as we6> recently introduced a breaking change in WebContainer, making older versions of7> `@webcontainer/api` generate invalid `HostURL.href` and `HostURL.hostname`8> when those methods are called inside a WebContainer.9 10Set of environment utilities for [WebContainers](https://blog.stackblitz.com/posts/introducing-webcontainers/).11 12## Install13 14```shell15$ npm install @webcontainer/env16```17 18## API19 20### `isWebContainer(): boolean` (method)21 22Returns a `boolean` indicating whether the program runs in a WebContainer.23 24### `HostURL` (class)25 26The `HostURL` class represents a host specific URL. It can be used to parse a regular URL, such as27`http://localhost:1234`, into a `HostURL`. Only if the program is executed in a WebContainer,28the `hostname` is resolved to a WebContainer hostname, e.g. `http://blitz--1234.local.webcontainer.io`.29This can be useful to create platform-dependent OAuth callback URLs.30 31#### [`HostURL.port(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/port) (getter)32 33#### [`HostURL.hash(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/hash) (getter)34 35#### [`HostURL.host(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/host) (getter)36 37#### [`HostURL.hostname(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/hostname) (getter)38 39#### [`HostURL.href(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/href) (getter)40 41#### [`HostURL.origin(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/origin) (getter)42 43#### [`HostURL.username(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/username) (getter)44 45#### [`HostURL.password(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/password) (getter)46 47#### [`HostURL.pathname(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname) (getter)48 49#### [`HostURL.protocol(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/protocol) (getter)50 51#### [`HostURL.search(): string`](https://developer.mozilla.org/en-US/docs/Web/API/URL/search) (getter)52 53#### [`HostURL.searchParams(): URLSearchParams`](https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams) (getter)54 55#### `HostURL.parse(url: string | URL): HostURL` (static method)56 57Parses a `url` into a `HostURL`. On local this is a no-op but when running in a WebContainer it resolves `localhost`58to a WebContainer hostname.59 60**Example**61 62```js63import { HostURL, isWebContainer } from '@webcontainer/env';64 65const hostURL = HostURL.parse('http://localhost:1234');66 67/**68 * Note that this branching would not be necessary as the host URL gets parsed69 * and resolved automatically through `HostURL.parse()` (see above). So `href`70 * will return a different value depending on the environment. This is illustrated71 * with the following `if` statement.72 */73if (isWebContainer()) {74  console.log(hostURL.href); // http://blitz--1234.local.webcontainer.io75} else {76  console.log(hostURL.href); // http://localhost:123477}78```79 80#### `HostURL.update(change: Partial<UpdateableURLProperties>): HostURL` (method)81 82Updates the `HostURL`.83 84##### **change**85 86Object containing the URL changes. Note that some properties are immutable (read-only), e.g. `origin` or `searchParams`. When updating the `port` it automatically updates the `host`.87 88Type: `Partial<UpdateableURLProperties>`89 90```js91interface UpdateableURLProperties {92  hash: string;93  host: string;94  hostname: string;95  href: string;96  password: string;97  pathname: string;98  port: string;99  protocol: string;100  search: string;101  username: string;102}103```104 105#### `HostURL.toString(): string` (method)106 107Stringifies the HostURL. It is effectively a read-only version of `HostURL.href`.108 109#### `HostURL.toJSON(): string` (method)110 111Returns a string containing a serialized version of the `HostURL`.112