File

src/modules/http/builder/http-create-request-builder.intf.ts

Description

This interface describes the different operations supported by Http request builders for "resource-creating" requests

Extends

StarkHttpBaseRequestBuilder

Index

Methods

Methods

echo
echo(echo: StarkHttpEchoType)

Adds an "echo" query parameter to the request

Parameters :
Name Type Optional Description
echo StarkHttpEchoType No
  • Echo parameter to specify whether the response should contain a response body
import { StarkHttpEchoType } from "../constants";
import { StarkHttpBaseRequestBuilder } from "./http-abstract-base-request-builder.intf";
import { StarkResource } from "../entities/resource.entity.intf";

/**
 * This interface describes the different operations supported by Http request builders for "resource-creating" requests
 */
export interface StarkHttpCreateRequestBuilder<T extends StarkResource> extends StarkHttpBaseRequestBuilder<T> {
	/**
	 * Adds an "echo" query parameter to the request
	 *
	 * @param echo - Echo parameter to specify whether the response should contain a response body
	 * @returns The current builder
	 */
	echo(echo: StarkHttpEchoType): this;
}

results matching ""

    No results matching ""