Header menu logo FsHttp

DslCE Module

Types

Type Description

HttpBuilder

Type extensions

Type extension Description

Accept contentType

Full Usage: Accept contentType

Parameters:
    contentType : string

Returns: HeaderContext

Content-Types that are acceptable for the response

Extended Type: IRequestContext

contentType : string
Returns: HeaderContext

AcceptCharset characterSets

Full Usage: AcceptCharset characterSets

Parameters:
    characterSets : string

Returns: HeaderContext

Character sets that are acceptable

Extended Type: IRequestContext

characterSets : string
Returns: HeaderContext

AcceptDatetime dateTime

Full Usage: AcceptDatetime dateTime

Parameters:
Returns: HeaderContext

Acceptable version in time

Extended Type: IRequestContext

dateTime : DateTime
Returns: HeaderContext

AcceptEncoding encoding

Full Usage: AcceptEncoding encoding

Parameters:
    encoding : string

Returns: HeaderContext

List of acceptable encodings. See HTTP compression.

Extended Type: IRequestContext

encoding : string
Returns: HeaderContext

AcceptLanguage language

Full Usage: AcceptLanguage language

Parameters:
    language : string

Returns: HeaderContext

List of acceptable human languages for response

Extended Type: IRequestContext

language : string
Returns: HeaderContext

Authorization credentials

Full Usage: Authorization credentials

Parameters:
    credentials : string

Returns: HeaderContext

Authorization credentials for HTTP authorization

Extended Type: IRequestContext

credentials : string
Returns: HeaderContext

AuthorizationBearer token

Full Usage: AuthorizationBearer token

Parameters:
    token : string

Returns: HeaderContext

Authorization header using Bearer authorization token

Extended Type: IRequestContext

token : string
Returns: HeaderContext

AuthorizationUserPw username password

Full Usage: AuthorizationUserPw username password

Parameters:
    username : string
    password : string

Returns: HeaderContext

Authorization header using Basic (User/Password) authorization

Extended Type: IRequestContext

username : string
password : string
Returns: HeaderContext

binary data

Full Usage: binary data

Parameters:
    data : byte array

Returns: BodyContext

Extended Type: IRequestContext

data : byte array
Returns: BodyContext

binaryPart value name ?fileName

Full Usage: binaryPart value name ?fileName

Parameters:
    value : byte[]
    name : string
    ?fileName : string

Returns: MultipartElementContext

Extended Type: IRequestContext

value : byte[]
name : string
?fileName : string
Returns: MultipartElementContext

body

Full Usage: body

Returns: BodyContext

An explicit transformation from a previous context to allow for describing the request body.

Extended Type: IRequestContext

Returns: BodyContext

CacheControl control

Full Usage: CacheControl control

Parameters:
    control : string

Returns: HeaderContext

Used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain

Extended Type: IRequestContext

control : string
Returns: HeaderContext

config_cancellationToken cancellationToken

Full Usage: config_cancellationToken cancellationToken

Parameters:
Returns: 'b

Extended Type: IRequestContext

cancellationToken : CancellationToken
Returns: 'b

CONNECT url

Full Usage: CONNECT url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

Connection connection

Full Usage: Connection connection

Parameters:
    connection : string

Returns: HeaderContext

What type of connection the user-agent would prefer

Extended Type: IRequestContext

connection : string
Returns: HeaderContext

content contentType data

Full Usage: content contentType data

Parameters:
Returns: BodyContext

Extended Type: IRequestContext

contentType : ContentType
data : ContentData
Returns: BodyContext

ContentEncoding encoding

Full Usage: ContentEncoding encoding

Parameters:
    encoding : string

Returns: BodyContext

The type of encoding used on the data

Extended Type: IRequestContext

encoding : string
Returns: BodyContext

ContentType contentType ?charset

Full Usage: ContentType contentType ?charset

Parameters:
    contentType : string
    ?charset : Encoding

Returns: BodyContext

The MIME type of the body of the request (used with POST and PUT requests) with an optional encoding

Extended Type: IRequestContext

contentType : string
?charset : Encoding
Returns: BodyContext

ContentType contentType ?charset

Full Usage: ContentType contentType ?charset

Parameters:
    contentType : string
    ?charset : Encoding

Returns: MultipartElementContext

The MIME type of the body of the request (used with POST and PUT requests) with an optional encoding

Extended Type: IRequestContext

contentType : string
?charset : Encoding
Returns: MultipartElementContext

Date date

Full Usage: Date date

Parameters:
Returns: HeaderContext

The date and time that the message was sent

Extended Type: IRequestContext

date : DateTime
Returns: HeaderContext

config_decompressionMethods decompressionMethods

Full Usage: config_decompressionMethods decompressionMethods

Parameters:
Returns: 'b

Extended Type: IRequestContext

decompressionMethods : DecompressionMethods list
Returns: 'b

DELETE url

Full Usage: DELETE url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

Expect behaviors

Full Usage: Expect behaviors

Parameters:
    behaviors : string

Returns: HeaderContext

Indicates that particular server behaviors are required by the client

Extended Type: IRequestContext

behaviors : string
Returns: HeaderContext

Expires dateTime

Full Usage: Expires dateTime

Parameters:
Returns: HeaderContext

Gives the date/time after which the response is considered stale

Extended Type: IRequestContext

dateTime : DateTime
Returns: HeaderContext

file path

Full Usage: file path

Parameters:
    path : string

Returns: BodyContext

Extended Type: IRequestContext

path : string
Returns: BodyContext

filePart path ?name ?fileName

Full Usage: filePart path ?name ?fileName

Parameters:
    path : string
    ?name : string
    ?fileName : string

Returns: MultipartElementContext

Extended Type: IRequestContext

path : string
?name : string
?fileName : string
Returns: MultipartElementContext

formUrlEncoded data

Full Usage: formUrlEncoded data

Parameters:
    data : (string * string) list

Returns: BodyContext

Extended Type: IRequestContext

data : (string * string) list
Returns: BodyContext

From email

Full Usage: From email

Parameters:
    email : string

Returns: HeaderContext

The email address of the user making the request

Extended Type: IRequestContext

email : string
Returns: HeaderContext

GET url

Full Usage: GET url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

HEAD url

Full Usage: HEAD url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

header key value

Full Usage: header key value

Parameters:
    key : string
    value : string

Returns: HeaderContext

Custom header

Extended Type: IRequestContext

key : string
value : string
Returns: HeaderContext

print_headerOnly

Full Usage: print_headerOnly

Returns: 'b

Extended Type: IRequestContext

Returns: 'b

headers headers

Full Usage: headers headers

Parameters:
    headers : (string * string) seq

Returns: HeaderContext

Custom headers

Extended Type: IRequestContext

headers : (string * string) seq
Returns: HeaderContext

Host host

Full Usage: Host host

Parameters:
    host : string

Returns: HeaderContext

The domain name of the server (for virtual hosting), and the TCP port number on which the server is listening. The port number may be omitted if the port is the standard port for the service requested.

Extended Type: IRequestContext

host : string
Returns: HeaderContext

IfMatch entity

Full Usage: IfMatch entity

Parameters:
    entity : string

Returns: HeaderContext

Only perform the action if the client supplied entity matches the same entity on the server. This is mainly for methods like PUT to only update a resource if it has not been modified since the user last updated it. If-Match: "737060cd8c284d8af7ad3082f209582d" Permanent

Extended Type: IRequestContext

entity : string
Returns: HeaderContext

IfModifiedSince dateTime

Full Usage: IfModifiedSince dateTime

Parameters:
Returns: HeaderContext

Allows a 304 Not Modified to be returned if content is unchanged

Extended Type: IRequestContext

dateTime : DateTime
Returns: HeaderContext

IfNoneMatch etag

Full Usage: IfNoneMatch etag

Parameters:
    etag : string

Returns: HeaderContext

Allows a 304 Not Modified to be returned if content is unchanged

Extended Type: IRequestContext

etag : string
Returns: HeaderContext

IfRange range

Full Usage: IfRange range

Parameters:
    range : string

Returns: HeaderContext

If the entity is unchanged, send me the part(s) that I am missing; otherwise, send me the entire new entity

Extended Type: IRequestContext

range : string
Returns: HeaderContext

IfUnmodifiedSince dateTime

Full Usage: IfUnmodifiedSince dateTime

Parameters:
Returns: HeaderContext

Only send the response if the entity has not been modified since a specific time

Extended Type: IRequestContext

dateTime : DateTime
Returns: HeaderContext

config_ignoreCertIssues

Full Usage: config_ignoreCertIssues

Returns: 'b

Extended Type: IRequestContext

Returns: 'b

json json

Full Usage: json json

Parameters:
    json : string

Returns: BodyContext

Extended Type: IRequestContext

json : string
Returns: BodyContext

jsonSerialize instance

Full Usage: jsonSerialize instance

Parameters:
    instance : 'a

Returns: BodyContext

Extended Type: IRequestContext

instance : 'a
Returns: BodyContext

jsonSerializeWith options instance

Full Usage: jsonSerializeWith options instance

Parameters:
Returns: BodyContext

Extended Type: IRequestContext

options : JsonSerializerOptions
instance : 'a
Returns: BodyContext

KeepAlive keepAlive

Full Usage: KeepAlive keepAlive

Parameters:
    keepAlive : string

Returns: HeaderContext

Specifies a parameter used into order to maintain a persistent connection

Extended Type: IRequestContext

keepAlive : string
Returns: HeaderContext

LastModified dateTime

Full Usage: LastModified dateTime

Parameters:
Returns: HeaderContext

Specifies the date and time at which the accompanying body data was last modified

Extended Type: IRequestContext

dateTime : DateTime
Returns: HeaderContext

MaxForwards count

Full Usage: MaxForwards count

Parameters:
    count : int

Returns: HeaderContext

Limit the number of times the message can be forwarded through proxies or gateways

Extended Type: IRequestContext

count : int
Returns: HeaderContext

Method method url

Full Usage: Method method url

Parameters:
    method : string
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

method : string
url : string
Returns: HeaderContext

multipart

Full Usage: multipart

Returns: MultipartContext

An explicit transformation from a previous context to allow for describing the request multiparts.

Extended Type: IRequestContext

Returns: MultipartContext

config_noDecompression

Full Usage: config_noDecompression

Returns: 'b

Extended Type: IRequestContext

Returns: 'b

config_noTimeout

Full Usage: config_noTimeout

Returns: 'b

Extended Type: IRequestContext

Returns: 'b

OPTIONS url

Full Usage: OPTIONS url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

Origin origin

Full Usage: Origin origin

Parameters:
    origin : string

Returns: HeaderContext

Initiates a request for cross-origin resource sharing (asks server for an 'Access-Control-Allow-Origin' response header)

Extended Type: IRequestContext

origin : string
Returns: HeaderContext

PATCH url

Full Usage: PATCH url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

POST url

Full Usage: POST url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

Pragma pragma

Full Usage: Pragma pragma

Parameters:
    pragma : string

Returns: HeaderContext

Implementation-specific headers that may have various effects anywhere along the request-response chain.

Extended Type: IRequestContext

pragma : string
Returns: HeaderContext

Prefer prefer

Full Usage: Prefer prefer

Parameters:
    prefer : string

Returns: HeaderContext

Optional instructions to the server to control request processing. See RFC https://tools.ietf.org/html/rfc7240 for more details

Extended Type: IRequestContext

prefer : string
Returns: HeaderContext

config_proxy url

Full Usage: config_proxy url

Parameters:
    url : string

Returns: 'b

Extended Type: IRequestContext

url : string
Returns: 'b

ProxyAuthorization credentials

Full Usage: ProxyAuthorization credentials

Parameters:
    credentials : string

Returns: HeaderContext

Authorization credentials for connecting to a proxy.

Extended Type: IRequestContext

credentials : string
Returns: HeaderContext

config_proxyWithCredentials url credentials

Full Usage: config_proxyWithCredentials url credentials

Parameters:
Returns: 'b

Extended Type: IRequestContext

url : string
credentials : ICredentials
Returns: 'b

PUT url

Full Usage: PUT url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

query queryParams

Full Usage: query queryParams

Parameters:
    queryParams : (string * string) list

Returns: HeaderContext

Append query params

Extended Type: IRequestContext

queryParams : (string * string) list
Returns: HeaderContext

Range start finish

Full Usage: Range start finish

Parameters:
    start : int64
    finish : int64

Returns: HeaderContext

Request only part of an entity. Bytes are numbered from 0

Extended Type: IRequestContext

start : int64
finish : int64
Returns: HeaderContext

Referer referer

Full Usage: Referer referer

Parameters:
    referer : string

Returns: HeaderContext

This is the address of the previous web page from which a link to the currently requested page was followed. (The word "referrer" is misspelled in the RFC as well as in most implementations.)

Extended Type: IRequestContext

referer : string
Returns: HeaderContext

config_set transformer

Full Usage: config_set transformer

Parameters:
Returns: 'b

Extended Type: IRequestContext

transformer : Config
Returns: 'b

print_set printHint

Full Usage: print_set printHint

Parameters:
Returns: 'b

Extended Type: IRequestContext

printHint : PrintHint
Returns: 'b

Cookie name value

Full Usage: Cookie name value

Parameters:
    name : string
    value : string

Returns: HeaderContext

An HTTP cookie previously sent by the server with 'Set-Cookie'.

Extended Type: IRequestContext

name : string
value : string
Returns: HeaderContext

CookieForDomain name value path domain

Full Usage: CookieForDomain name value path domain

Parameters:
    name : string
    value : string
    path : string
    domain : string

Returns: HeaderContext

An HTTP cookie previously sent by the server with 'Set-Cookie' with the subset of URIs on the origin server to which this Cookie applies and the internet domain for which this Cookie is valid.

Extended Type: IRequestContext

name : string
value : string
path : string
domain : string
Returns: HeaderContext

CookieForPath name value path

Full Usage: CookieForPath name value path

Parameters:
    name : string
    value : string
    path : string

Returns: HeaderContext

An HTTP cookie previously sent by the server with 'Set-Cookie' with the subset of URIs on the origin server to which this Cookie applies.

Extended Type: IRequestContext

name : string
value : string
path : string
Returns: HeaderContext

config_setHttpClientFactory httpClientFactory

Full Usage: config_setHttpClientFactory httpClientFactory

Parameters:
Returns: 'b

Extended Type: IRequestContext

httpClientFactory : Config -> HttpClient
Returns: 'b

stream stream

Full Usage: stream stream

Parameters:
Returns: BodyContext

Extended Type: IRequestContext

stream : Stream
Returns: BodyContext

streamPart value name ?fileName

Full Usage: streamPart value name ?fileName

Parameters:
    value : Stream
    name : string
    ?fileName : string

Returns: MultipartElementContext

Extended Type: IRequestContext

value : Stream
name : string
?fileName : string
Returns: MultipartElementContext

TE te

Full Usage: TE te

Parameters:
    te : string

Returns: HeaderContext

The transfer encodings the user agent is willing to accept: the same values as for the response header Transfer-Encoding can be used, plus the "trailers" value (related to the "chunked" transfer method) to notify the server it expects to receive additional headers (the trailers) after the last, zero-sized, chunk.

Extended Type: IRequestContext

te : string
Returns: HeaderContext

text text

Full Usage: text text

Parameters:
    text : string

Returns: BodyContext

Extended Type: IRequestContext

text : string
Returns: BodyContext

textPart value name ?fileName

Full Usage: textPart value name ?fileName

Parameters:
    value : string
    name : string
    ?fileName : string

Returns: MultipartElementContext

Extended Type: IRequestContext

value : string
name : string
?fileName : string
Returns: MultipartElementContext

config_timeout value

Full Usage: config_timeout value

Parameters:
Returns: 'b

Extended Type: IRequestContext

value : TimeSpan
Returns: 'b

config_timeoutInSeconds value

Full Usage: config_timeoutInSeconds value

Parameters:
    value : float

Returns: 'b

Extended Type: IRequestContext

value : float
Returns: 'b

TRACE url

Full Usage: TRACE url

Parameters:
    url : string

Returns: HeaderContext

Extended Type: IRequestContext

url : string
Returns: HeaderContext

Trailer trailer

Full Usage: Trailer trailer

Parameters:
    trailer : string

Returns: HeaderContext

The Trailer general field value indicates that the given set of header fields is present in the trailer of a message encoded with chunked transfer-coding

Extended Type: IRequestContext

trailer : string
Returns: HeaderContext

TransferEncoding directive

Full Usage: TransferEncoding directive

Parameters:
    directive : string

Returns: HeaderContext

The TransferEncoding header indicates the form of encoding used to safely transfer the entity to the user. The valid directives are one of: chunked, compress, deflate, gzip, orentity.

Extended Type: IRequestContext

directive : string
Returns: HeaderContext

config_transformHeader transformer

Full Usage: config_transformHeader transformer

Parameters:
Returns: 'b

Extended Type: IRequestContext

transformer : Header -> Header
Returns: 'b

config_transformHttpClient transformer

Full Usage: config_transformHttpClient transformer

Parameters:
Returns: 'b

Extended Type: IRequestContext

transformer : HttpClient -> HttpClient
Returns: 'b

config_transformHttpClientHandler transformer

Full Usage: config_transformHttpClientHandler transformer

Parameters:
Returns: 'b

Extended Type: IRequestContext

transformer : SocketsHttpHandler -> SocketsHttpHandler
Returns: 'b

config_transformHttpRequestMessage transformer

Full Usage: config_transformHttpRequestMessage transformer

Parameters:
Returns: 'b

Extended Type: IRequestContext

transformer : HttpRequestMessage -> HttpRequestMessage
Returns: 'b

config_transformUrl transformer

Full Usage: config_transformUrl transformer

Parameters:
    transformer : string -> string

Returns: 'b

Extended Type: IRequestContext

transformer : string -> string
Returns: 'b

Translate translate

Full Usage: Translate translate

Parameters:
    translate : string

Returns: HeaderContext

Microsoft extension to the HTTP specification used in conjunction with WebDAV functionality.

Extended Type: IRequestContext

translate : string
Returns: HeaderContext

config_update transformer

Full Usage: config_update transformer

Parameters:
Returns: 'b

Extended Type: IRequestContext

transformer : Config -> Config
Returns: 'b

print_update transformer

Full Usage: print_update transformer

Parameters:
Returns: 'b

Extended Type: IRequestContext

transformer : PrintHint -> PrintHint
Returns: 'b

Upgrade upgrade

Full Usage: Upgrade upgrade

Parameters:
    upgrade : string

Returns: HeaderContext

Specifies additional communications protocols that the client supports.

Extended Type: IRequestContext

upgrade : string
Returns: HeaderContext

config_useBaseUrl baseUrl

Full Usage: config_useBaseUrl baseUrl

Parameters:
    baseUrl : string

Returns: 'b

Extended Type: IRequestContext

baseUrl : string
Returns: 'b

print_useObjectFormatting

Full Usage: print_useObjectFormatting

Returns: 'c

Extended Type: IRequestContext

Returns: 'c

UserAgent userAgent

Full Usage: UserAgent userAgent

Parameters:
    userAgent : string

Returns: HeaderContext

The user agent string of the user agent

Extended Type: IRequestContext

userAgent : string
Returns: HeaderContext

Via server

Full Usage: Via server

Parameters:
    server : string

Returns: HeaderContext

Informs the server of proxies through which the request was sent

Extended Type: IRequestContext

server : string
Returns: HeaderContext

Warning message

Full Usage: Warning message

Parameters:
    message : string

Returns: HeaderContext

A general warning about possible problems with the entity body

Extended Type: IRequestContext

message : string
Returns: HeaderContext

print_withRequestPrintMode updatePrintMode

Full Usage: print_withRequestPrintMode updatePrintMode

Parameters:
Returns: 'b

Extended Type: IRequestContext

updatePrintMode : PrintMode<unit> -> PrintMode<unit>
Returns: 'b

print_withResponseBody updateBodyPrintMode

Full Usage: print_withResponseBody updateBodyPrintMode

Parameters:
Returns: 'b

Extended Type: IRequestContext

updateBodyPrintMode : BodyPrintMode -> BodyPrintMode
Returns: 'b

print_withResponseBodyExpanded

Full Usage: print_withResponseBodyExpanded

Returns: 'b

Extended Type: IRequestContext

Returns: 'b

print_withResponseBodyFormat format

Full Usage: print_withResponseBodyFormat format

Parameters:
    format : bool

Returns: 'b

Extended Type: IRequestContext

format : bool
Returns: 'b

print_withResponseBodyLength maxLength

Full Usage: print_withResponseBodyLength maxLength

Parameters:
    maxLength : int

Returns: 'b

Extended Type: IRequestContext

maxLength : int
Returns: 'b

print_withResponsePrintMode updatePrintMode

Full Usage: print_withResponsePrintMode updatePrintMode

Parameters:
Returns: 'b

Extended Type: IRequestContext

updatePrintMode : PrintMode<BodyPrintMode> -> PrintMode<BodyPrintMode>
Returns: 'b

XHTTPMethodOverride httpMethod

Full Usage: XHTTPMethodOverride httpMethod

Parameters:
    httpMethod : string

Returns: HeaderContext

Override HTTP method.

Extended Type: IRequestContext

httpMethod : string
Returns: HeaderContext

this.Yield

Full Usage: this.Yield

Parameters:
    arg0 : 'a

Returns: IRequestContext<'self>

Extended Type: IRequestContext

arg0 : 'a
Returns: IRequestContext<'self>

Type something to start searching.