remote/sveltekit-guard.server

Interfaces

SvelteKitGuardConstructor

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:98

Constructors

Constructor

new SvelteKitGuardConstructor(middleware): SvelteKitGuardInstance;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:99

Parameters

Parameter	Type
`middleware`	readonly `Middleware`[]

Returns

SvelteKitGuardInstance

Methods

init()

init(): SvelteKitGuardInstance;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:100

Returns

SvelteKitGuardInstance

SvelteKitGuardInstance

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:65

Properties

middleware

readonly middleware: readonly Middleware[];

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:66

Methods

command()

Call Signature

command<Output>(handler): RemoteCommand<void, Output>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:68

Type Parameters

Type Parameter
`Output`

Parameters

Parameter	Type
`handler`	() => `MaybePromise`<`Output`>

Returns

RemoteCommand<void, Output>

Call Signature

command<Schema, Output>(schema, handler): RemoteCommand<RemoteSchemaInput<Schema>, Output>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:69

Type Parameters

Type Parameter
`Schema` extends `StandardSchemaV1`<`unknown`, `unknown`>
`Output`

Parameters

Parameter	Type
`schema`	`Schema`
`handler`	(`input`) => `MaybePromise`<`Output`>

Returns

RemoteCommand<RemoteSchemaInput<Schema>, Output>

form()

Call Signature

form<Schema, Output>(schema, handler): RemoteForm<RemoteSchemaInput<Schema>, Output>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:85

Type Parameters

Type Parameter
`Schema` extends `StandardSchemaV1`<`RemoteFormInput`, `Record`<`string`, `unknown`>>
`Output`

Parameters

Parameter	Type
`schema`	`Schema`
`handler`	(`data`, `issue`) => `MaybePromise`<`Output`>

Returns

RemoteForm<RemoteSchemaInput<Schema>, Output>

Call Signature

form<Output>(mode, handler): RemoteForm<RemoteFormInput, Output>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:92

Type Parameters

Type Parameter
`Output`

Parameters

Parameter	Type
`mode`	`"unchecked"`
`handler`	(`data`) => `MaybePromise`<`Output`>

Returns

RemoteForm<RemoteFormInput, Output>

live()

Call Signature

live<Output>(generator): RemoteLiveQueryFunction<void, Output>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:78

Type Parameters

Type Parameter
`Output`

Parameters

Parameter	Type
`generator`	() => `RemoteLiveGeneratorReturn`<`Output`>

Returns

RemoteLiveQueryFunction<void, Output>

Call Signature

live<Schema, Output>(schema, generator): RemoteLiveQueryFunction<RemoteSchemaInput<Schema>, Output, RemoteSchemaOutput<Schema>>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:81

Type Parameters

Type Parameter
`Schema` extends `StandardSchemaV1`<`unknown`, `unknown`>
`Output`

Parameters

Parameter	Type
`schema`	`Schema`
`generator`	(`input`) => `RemoteLiveGeneratorReturn`<`Output`>

Returns

RemoteLiveQueryFunction<RemoteSchemaInput<Schema>, Output, RemoteSchemaOutput<Schema>>

query()

Call Signature

query<Output>(handler): RemoteQueryFunction<void, Output, void>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:73

Type Parameters

Type Parameter
`Output`

Parameters

Parameter	Type
`handler`	() => `MaybePromise`<`Output`>

Returns

RemoteQueryFunction<void, Output, void>

Call Signature

query<Schema, Output>(schema, handler): RemoteQueryFunction<RemoteSchemaInput<Schema>, Output, RemoteSchemaOutput<Schema>>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:74

Type Parameters

Type Parameter
`Schema` extends `StandardSchemaV1`<`unknown`, `unknown`>
`Output`

Parameters

Parameter	Type
`schema`	`Schema`
`handler`	(`input`) => `MaybePromise`<`Output`>

Returns

RemoteQueryFunction<RemoteSchemaInput<Schema>, Output, RemoteSchemaOutput<Schema>>

use()

use(mw): SvelteKitGuardInstance;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:67

Parameters

Parameter	Type
`mw`	`Middleware`

Returns

SvelteKitGuardInstance

Type Aliases

GuardWrapHandler

type GuardWrapHandler = <I, O>(middleware, handler) => (input) => MaybePromise<O>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:21

Type Parameters

Type Parameter
`I`
`O`

Parameters

Parameter	Type
`middleware`	readonly `Middleware`[]
`handler`	(`input`) => `MaybePromise`<`O`>

Returns

(input) => MaybePromise<O>

SvelteKitQueryBindings()

type SvelteKitQueryBindings = RemoteQueryFunction<void, Output, void>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:26

Call Signature

type SvelteKitQueryBindings<Output>(handler): RemoteQueryFunction<void, Output, void>;

Type Parameters

Type Parameter
`Output`

Parameters

Parameter	Type
`handler`	() => `MaybePromise`<`Output`>

Returns

RemoteQueryFunction<void, Output, void>

Call Signature

type SvelteKitQueryBindings<Schema, Output>(schema, handler): RemoteQueryFunction<RemoteSchemaInput<Schema>, Output, RemoteSchemaOutput<Schema>>;

Type Parameters

Type Parameter
`Schema` extends `StandardSchemaV1`<`unknown`, `unknown`>
`Output`

Parameters

Parameter	Type
`schema`	`Schema`
`handler`	(`input`) => `MaybePromise`<`Output`>

Returns

RemoteQueryFunction<RemoteSchemaInput<Schema>, Output, RemoteSchemaOutput<Schema>>

Methods

live()

Call Signature

live<Output>(generator): RemoteLiveQueryFunction<void, Output>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:32

Type Parameters

Type Parameter
`Output`

Parameters

Parameter	Type
`generator`	() => `RemoteLiveGeneratorReturn`<`Output`>

Returns

RemoteLiveQueryFunction<void, Output>

Call Signature

live<Schema, Output>(schema, generator): RemoteLiveQueryFunction<RemoteSchemaInput<Schema>, Output, RemoteSchemaOutput<Schema>>;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:35

Type Parameters

Type Parameter
`Schema` extends `StandardSchemaV1`<`unknown`, `unknown`>
`Output`

Parameters

Parameter	Type
`schema`	`Schema`
`generator`	(`input`) => `RemoteLiveGeneratorReturn`<`Output`>

Returns

RemoteLiveQueryFunction<RemoteSchemaInput<Schema>, Output, RemoteSchemaOutput<Schema>>

SvelteKitRemoteBindings

type SvelteKitRemoteBindings = object;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:41

Properties

Property	Type	Defined in
`command`	{ <`Output`> (`handler`): `RemoteCommand`<`void`, `Output`>; <`Schema`, `Output`> (`schema`, `handler`): `RemoteCommand`<`RemoteSchemaInput`<`Schema`>, `Output`>; }	platform-utils/src/remote/sveltekit-guard.server.ts:42
`form`	{ <`Schema`, `Output`> (`schema`, `handler`): `RemoteForm`<`RemoteSchemaInput`<`Schema`>, `Output`>; <`Output`> (`mode`, `handler`): `RemoteForm`<`RemoteFormInput`, `Output`>; }	platform-utils/src/remote/sveltekit-guard.server.ts:50
`query`	`SvelteKitQueryBindings`	platform-utils/src/remote/sveltekit-guard.server.ts:49

Functions

createSvelteKitGuard()

function createSvelteKitGuard(bindings, wrapHandler?): object;

Defined in: platform-utils/src/remote/sveltekit-guard.server.ts:103

Parameters

Parameter	Type	Default value
`bindings`	`SvelteKitRemoteBindings`	`undefined`
`wrapHandler`	`GuardWrapHandler`	`applyRemoteMiddleware`

Returns

object

Guard

Guard: SvelteKitGuardConstructor;