From 8892e83895d6c6112cb9e2528a644a4ab762602d Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Fri, 11 Oct 2024 16:22:13 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- classes/utils_echo_server.default.html | 4 ++-- functions/utils_chai.assert.html | 2 +- functions/utils_chai.expect.html | 2 +- functions/utils_fixtures.default.html | 2 +- functions/utils_get_port.default.html | 2 +- functions/utils_resolve.default.html | 2 +- modules/src.html | 2 +- modules/src_env.html | 2 +- modules/utils_chai.html | 2 +- modules/utils_echo_server.html | 2 +- modules/utils_fixtures.html | 2 +- modules/utils_get_port.html | 2 +- modules/utils_resolve.html | 2 +- types/src.BuildOptions.html | 2 +- types/src.DependencyCheckOptions.html | 2 +- types/src.DocsOptions.html | 2 +- types/src.GlobalOptions.html | 2 +- types/src.LintOptions.html | 2 +- types/src.Options.html | 2 +- types/src.PartialOptions.html | 2 +- types/src.ReleaseOptions.html | 2 +- types/src.TSOptions.html | 2 +- types/src.TestOptions.html | 2 +- 23 files changed, 24 insertions(+), 24 deletions(-) diff --git a/classes/utils_echo_server.default.html b/classes/utils_echo_server.default.html index e32ba3035..86d402f7d 100644 --- a/classes/utils_echo_server.default.html +++ b/classes/utils_echo_server.default.html @@ -1,7 +1,7 @@ default | aegir

Class default

HTTP echo server for testing purposes.

Example

const EchoServer = require('aegir/utils/echo-server')
const server = new EchoServer()
await server.start()

// search params echo endpoint
const req = await fetch('http://127.0.0.1:3000/echo/query?test=one')
console.log(await req.text())

// body echo endpoint
const req = await fetch('http://127.0.0.1:3000/echo', {
  method: 'POST',
  body: '{"key": "value"}'
})
console.log(await req.text())

// redirect endpoint
const req = await fetch('http://127.0.0.1:3000/redirect?to=http://127.0.0.1:3000/echo')
console.log(await req.text())

// download endpoint
const req = await fetch('http://127.0.0.1:3000/download?data=helloWorld')
console.log(await req.text())

await server.stop()
-

Constructors

constructor +

Constructors

constructor

Properties

host options polka @@ -14,4 +14,4 @@
  • findPort: undefined | boolean

    flag to check for ports

  • host: undefined | string

    server host

  • port: undefined | number

    server port

    -

Returns default

Properties

host

host: string

options

options: {
    findPort: undefined | boolean;
    host: undefined | string;
    port: undefined | number;
}

Type declaration

  • findPort: undefined | boolean
  • host: undefined | string
  • port: undefined | number

polka

polka: Polka

port

port: number

server

server: Server<typeof IncomingMessage, typeof ServerResponse>

started

started: boolean

Methods

start

stop

Settings

Member Visibility

Theme

On This Page

constructorhostoptionspolkaportserverstartedstartstop
\ No newline at end of file +

Returns default

Properties

host

host: string

options

options: {
    findPort: undefined | boolean;
    host: undefined | string;
    port: undefined | number;
}

Type declaration

  • findPort: undefined | boolean
  • host: undefined | string
  • port: undefined | number

polka

polka: Polka

port

port: number

server

server: Server<typeof IncomingMessage, typeof ServerResponse>

started

started: boolean

Methods

start

stop

Settings

Member Visibility

Theme

On This Page

constructorhostoptionspolkaportserverstartedstartstop
\ No newline at end of file diff --git a/functions/utils_chai.assert.html b/functions/utils_chai.assert.html index 43d23b780..fe4a9813a 100644 --- a/functions/utils_chai.assert.html +++ b/functions/utils_chai.assert.html @@ -1,7 +1,7 @@ assert | aegir

Function assert

  • assert(expression, message?): asserts expression

  • Parameters

    • expression: any
    • Optional message: string

    Returns asserts expression

    See

    Chai assert docs

    Example

    import { assert } from 'aegir/chai'

    assert(true)
    -

Properties

eventually +

Properties

eventually

Methods

Throw approximately becomes diff --git a/functions/utils_chai.expect.html b/functions/utils_chai.expect.html index b3ce0fc7b..598fa9886 100644 --- a/functions/utils_chai.expect.html +++ b/functions/utils_chai.expect.html @@ -1,5 +1,5 @@ expect | aegir

Function expect

Methods

fail +

Methods

fail

Methods

fail

  • fail(message?): never

  • Parameters

    • Optional message: string

    Returns never

  • fail(actual, expected, message?, operator?): never

  • Parameters

    • actual: any
    • expected: any
    • Optional message: string
    • Optional operator: string

    Returns never

Settings

Member Visibility

Theme

On This Page

fail
\ No newline at end of file diff --git a/functions/utils_fixtures.default.html b/functions/utils_fixtures.default.html index c3781f694..601e992e2 100644 --- a/functions/utils_fixtures.default.html +++ b/functions/utils_fixtures.default.html @@ -7,4 +7,4 @@ the server is able to serve the correct files.

Example

// awesome-tests module
const loadFixture = require('aegir/utils/fixtures')

const myFixture = loadFixture('test/fixtures/coolfixture', 'awesome-tests')
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/utils_get_port.default.html b/functions/utils_get_port.default.html index 20add6f6e..eba52232f 100644 --- a/functions/utils_get_port.default.html +++ b/functions/utils_get_port.default.html @@ -1,4 +1,4 @@ default | aegir

Function default

  • default(port?, host?): Promise<number>

  • Helper to find an available port to put a server listening on.

    Parameters

    • port: number = 3000
    • host: string = '127.0.0.1'

    Returns Promise<number>

    Example

    const getPort = require('aegir/utils/get-port')
    const port = await getPort(3000, '127.0.0.1')
    // if 3000 is available returns 3000 if not returns a free port.
    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/utils_resolve.default.html b/functions/utils_resolve.default.html index a6a8c7f89..e1d042c6c 100644 --- a/functions/utils_resolve.default.html +++ b/functions/utils_resolve.default.html @@ -1,2 +1,2 @@ default | aegir

Function default

  • default(filePath, module?): string

  • Returns the full path to the requested resource, if available

    -

    Parameters

    • filePath: string
    • Optional module: string = ''

    Returns string

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/src.html b/modules/src.html index 70db79501..d5b76d1dd 100644 --- a/modules/src.html +++ b/modules/src.html @@ -1,4 +1,4 @@ -src | aegir

Module src

Index

Type Aliases

BuildOptions +src | aegir

Module src

Index

Type Aliases

BuildOptions DependencyCheckOptions DocsOptions GlobalOptions diff --git a/modules/src_env.html b/modules/src_env.html index 317953cc0..20db98153 100644 --- a/modules/src_env.html +++ b/modules/src_env.html @@ -1,7 +1,7 @@ src/env | aegir

Module src/env

Environment detection for test runs using wherearewe

Example

import { isNode } from 'aegir/env'

if (isNode) {
  // do node things
}
-

Index

Variables

isBrowser +

Index

Variables

isBrowser isElectron isElectronMain isElectronRenderer diff --git a/modules/utils_chai.html b/modules/utils_chai.html index 092916164..1b15c0f11 100644 --- a/modules/utils_chai.html +++ b/modules/utils_chai.html @@ -8,7 +8,7 @@

Example

import { expect } from 'aegir/chai'

expect(true).to.be.true()
-

Index

Namespaces

chaiString +

Index

Namespaces

chaiString

Variables

chai

Functions

assert chaiAsPromised diff --git a/modules/utils_echo_server.html b/modules/utils_echo_server.html index 9e1c42735..3597371f7 100644 --- a/modules/utils_echo_server.html +++ b/modules/utils_echo_server.html @@ -1,2 +1,2 @@ -utils/echo-server | aegir

Module utils/echo-server

Index

Classes

default +utils/echo-server | aegir

Module utils/echo-server

Index

Classes

default

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/utils_fixtures.html b/modules/utils_fixtures.html index 160cc54a9..f58db9cb1 100644 --- a/modules/utils_fixtures.html +++ b/modules/utils_fixtures.html @@ -1,2 +1,2 @@ -utils/fixtures | aegir

Module utils/fixtures

Index

Functions

default +utils/fixtures | aegir

Module utils/fixtures

Index

Functions

default

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/utils_get_port.html b/modules/utils_get_port.html index 3384ef494..4c247b67b 100644 --- a/modules/utils_get_port.html +++ b/modules/utils_get_port.html @@ -1,2 +1,2 @@ -utils/get-port | aegir

Module utils/get-port

Index

Functions

default +utils/get-port | aegir

Module utils/get-port

Index

Functions

default

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/modules/utils_resolve.html b/modules/utils_resolve.html index 08a08b301..a57b7d9b0 100644 --- a/modules/utils_resolve.html +++ b/modules/utils_resolve.html @@ -1,2 +1,2 @@ -utils/resolve | aegir

Module utils/resolve

Index

Functions

default +utils/resolve | aegir

Module utils/resolve

Index

Functions

default

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.BuildOptions.html b/types/src.BuildOptions.html index bf08fb627..79cfdc3d7 100644 --- a/types/src.BuildOptions.html +++ b/types/src.BuildOptions.html @@ -1 +1 @@ -BuildOptions | aegir

Type alias BuildOptions

BuildOptions: BuildOptions

Settings

Member Visibility

Theme

\ No newline at end of file +BuildOptions | aegir

Type alias BuildOptions

BuildOptions: BuildOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.DependencyCheckOptions.html b/types/src.DependencyCheckOptions.html index dd47cf9ee..b704cc530 100644 --- a/types/src.DependencyCheckOptions.html +++ b/types/src.DependencyCheckOptions.html @@ -1 +1 @@ -DependencyCheckOptions | aegir

Type alias DependencyCheckOptions

DependencyCheckOptions: DependencyCheckOptions

Settings

Member Visibility

Theme

\ No newline at end of file +DependencyCheckOptions | aegir

Type alias DependencyCheckOptions

DependencyCheckOptions: DependencyCheckOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.DocsOptions.html b/types/src.DocsOptions.html index aa1bb6f92..4f54b3658 100644 --- a/types/src.DocsOptions.html +++ b/types/src.DocsOptions.html @@ -1 +1 @@ -DocsOptions | aegir

Type alias DocsOptions

DocsOptions: DocsOptions

Settings

Member Visibility

Theme

\ No newline at end of file +DocsOptions | aegir

Type alias DocsOptions

DocsOptions: DocsOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.GlobalOptions.html b/types/src.GlobalOptions.html index 51d7c393d..a7a1c7cec 100644 --- a/types/src.GlobalOptions.html +++ b/types/src.GlobalOptions.html @@ -1 +1 @@ -GlobalOptions | aegir

Type alias GlobalOptions

GlobalOptions: GlobalOptions

Settings

Member Visibility

Theme

\ No newline at end of file +GlobalOptions | aegir

Type alias GlobalOptions

GlobalOptions: GlobalOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.LintOptions.html b/types/src.LintOptions.html index 63cf093e4..db7c9acec 100644 --- a/types/src.LintOptions.html +++ b/types/src.LintOptions.html @@ -1 +1 @@ -LintOptions | aegir

Type alias LintOptions

LintOptions: LintOptions

Settings

Member Visibility

Theme

\ No newline at end of file +LintOptions | aegir

Type alias LintOptions

LintOptions: LintOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.Options.html b/types/src.Options.html index ec5aff116..aecf1a4df 100644 --- a/types/src.Options.html +++ b/types/src.Options.html @@ -1 +1 @@ -Options | aegir

Type alias Options

Options: Options

Settings

Member Visibility

Theme

\ No newline at end of file +Options | aegir

Type alias Options

Options: Options

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.PartialOptions.html b/types/src.PartialOptions.html index f5b717e2d..6e3888907 100644 --- a/types/src.PartialOptions.html +++ b/types/src.PartialOptions.html @@ -1 +1 @@ -PartialOptions | aegir

Type alias PartialOptions

PartialOptions: PartialOptions

Settings

Member Visibility

Theme

\ No newline at end of file +PartialOptions | aegir

Type alias PartialOptions

PartialOptions: PartialOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.ReleaseOptions.html b/types/src.ReleaseOptions.html index caed7175a..8e90deb07 100644 --- a/types/src.ReleaseOptions.html +++ b/types/src.ReleaseOptions.html @@ -1 +1 @@ -ReleaseOptions | aegir

Type alias ReleaseOptions

ReleaseOptions: ReleaseOptions

Settings

Member Visibility

Theme

\ No newline at end of file +ReleaseOptions | aegir

Type alias ReleaseOptions

ReleaseOptions: ReleaseOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.TSOptions.html b/types/src.TSOptions.html index c0715403a..5e37596e9 100644 --- a/types/src.TSOptions.html +++ b/types/src.TSOptions.html @@ -1 +1 @@ -TSOptions | aegir

Type alias TSOptions

TSOptions: TSOptions

Settings

Member Visibility

Theme

\ No newline at end of file +TSOptions | aegir

Type alias TSOptions

TSOptions: TSOptions

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/src.TestOptions.html b/types/src.TestOptions.html index bf7d3afa2..ab9a46462 100644 --- a/types/src.TestOptions.html +++ b/types/src.TestOptions.html @@ -1 +1 @@ -TestOptions | aegir

Type alias TestOptions

TestOptions: TestOptions

Settings

Member Visibility

Theme

\ No newline at end of file +TestOptions | aegir

Type alias TestOptions

TestOptions: TestOptions

Settings

Member Visibility

Theme

\ No newline at end of file