@enonic/js-utils/types/Request.d.ts

Enonic XP JavaScript Utils

import {StringObject} from './Utility.d';

export namespace Enonic {
	export namespace Xp {
		export namespace Http {

			export interface DefaultHeaders extends Headers {
				accept?: string
				'accept-charset'?: string
				'accept-encoding'?: string
				authorization?: string

				// Could be made stricter
				// Cookie: value1; value2; name1=value1
				// SubCoookies: name=a=b&c=d&e=f&g=h
				cookies?: string

				'if-none-match'?: string
				language?: string
				'user-agent'?: string
			}

			export type Method = 'GET'|'POST'|'HEAD'|'PUT'|'DELETE'|'PATCH'

			export type Mode = 'edit'|'inline'|'live'|'preview'

			export type Request<
				Body = string,
				Cookies extends StringObject = StringObject,
				Headers extends StringObject = DefaultHeaders,
				Params extends StringObject = StringObject,
				PathParams extends StringObject = StringObject
			> = {
				body?: Body
				branch?: string
				contextPath?: string
				cookies?: Cookies
				headers?: Headers
				host?: string
				method?: Method
				mode?: Mode
				params?: Params
				path?: string
				pathParams?: PathParams
				port?: string|number
				rawPath?: string
				remoteAddress?: string
				scheme?: string
				url?: string
			} // Request

		} // Http
	} // Xp
} // Enonic