Pkldoc > schema.kdeps.com/core > org.kdeps.pkl.APIServer

APIServerSettings0.2.17

Properties
Methods

class APIServerSettings

Class representing the configuration settings for the API server.

Known subtypes:
Known usages:
All versions:

Properties

link

hostIP: String Source

The IP address the API server will bind to. Defaults to "127.0.0.1".
link

portNum: UInt16 Source

The port number the API server will listen on. Defaults to 3000.
link

trustedProxies: Listing<String>?Source

A list of trusted proxies (IPv4, IPv6, or CIDR ranges). If set, only requests passing through these proxies will have their X-Forwarded-For header trusted. If unset, all proxies—including potentially malicious ones—are considered trusted, which may expose the server to IP spoofing and other attacks.
link

routes: Listing<APIServerRoutes>Source

A listing of routes configured for the API server.

Each route defines a path and the allowed HTTP methods for that path.
link

cors: CORS Source

Cross-Origin Resource Sharing (CORS) configuration

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.