Header menu logo ApiStub.FSharp

TestClient<'T> Type

`TestClient` wraps `WebApplicationFactory` and exposes a builder CE with utility to define api client stubs and other features

Constructors

Constructor Description

TestClient()

Full Usage: TestClient()

Returns: TestClient<'T>
Returns: TestClient<'T>

Instance members

Instance member Description

WITH_SERVICES customAction

Full Usage: WITH_SERVICES customAction

Parameters:
Returns: TestClient<'T>
customAction : IServiceCollection -> IServiceCollection
Returns: TestClient<'T>

WITH_TEST_SERVICES customAction

Full Usage: WITH_TEST_SERVICES customAction

Parameters:
Returns: TestClient<'T>
customAction : IServiceCollection -> IServiceCollection
Returns: TestClient<'T>

DELETE route stub

Full Usage: DELETE route stub

Parameters:
Returns: TestClient<'T>

stub DELETE

route : string
stub : HttpRequestMessage -> RouteValueDictionary -> HttpResponseMessage
Returns: TestClient<'T>

DELETE_ASYNC route stub

Full Usage: DELETE_ASYNC route stub

Parameters:
Returns: TestClient<'T>

stub DELETE

route : string
stub : HttpRequestMessage -> RouteValueDictionary -> Task<HttpResponseMessage>
Returns: TestClient<'T>

DELETEJ route stub

Full Usage: DELETEJ route stub

Parameters:
    route : string
    stub : obj

Returns: TestClient<'T>

stub DELETE json

route : string
stub : obj
Returns: TestClient<'T>

GET route stub

Full Usage: GET route stub

Parameters:
Returns: TestClient<'T>

stub GET request with stub function

route : string
stub : HttpRequestMessage -> RouteValueDictionary -> HttpResponseMessage
Returns: TestClient<'T>

GET route stub

Full Usage: GET route stub

Parameters:
Returns: TestClient<'T>

stub GET request with stub object

route : string
stub : unit -> HttpResponseMessage
Returns: TestClient<'T>

GET_ASYNC route stub

Full Usage: GET_ASYNC route stub

Parameters:
Returns: TestClient<'T>

stub GET request with stub function

route : string
stub : HttpRequestMessage -> RouteValueDictionary -> Task<HttpResponseMessage>
Returns: TestClient<'T>

this.GetFactory

Full Usage: this.GetFactory

Returns: WebApplicationFactory<'T>
Returns: WebApplicationFactory<'T>

GETJ route stub

Full Usage: GETJ route stub

Parameters:
    route : string
    stub : obj

Returns: TestClient<'T>

stub GET json

route : string
stub : obj
Returns: TestClient<'T>

POST route stub

Full Usage: POST route stub

Parameters:
Returns: TestClient<'T>

stub POST

route : string
stub : HttpRequestMessage -> RouteValueDictionary -> HttpResponseMessage
Returns: TestClient<'T>

POST_ASYNC route stub

Full Usage: POST_ASYNC route stub

Parameters:
Returns: TestClient<'T>

stub POST

route : string
stub : HttpRequestMessage -> RouteValueDictionary -> Task<HttpResponseMessage>
Returns: TestClient<'T>

POSTJ route stub

Full Usage: POSTJ route stub

Parameters:
    route : string
    stub : obj

Returns: TestClient<'T>

stub POST json

route : string
stub : obj
Returns: TestClient<'T>

PUT route stub

Full Usage: PUT route stub

Parameters:
Returns: TestClient<'T>

stub PUT

route : string
stub : HttpRequestMessage -> RouteValueDictionary -> HttpResponseMessage
Returns: TestClient<'T>

PUT_ASYNC route stub

Full Usage: PUT_ASYNC route stub

Parameters:
Returns: TestClient<'T>

stub PUT

route : string
stub : HttpRequestMessage -> RouteValueDictionary -> Task<HttpResponseMessage>
Returns: TestClient<'T>

PUTJ route stub

Full Usage: PUTJ route stub

Parameters:
    route : string
    stub : obj

Returns: TestClient<'T>

stub PUT json

route : string
stub : obj
Returns: TestClient<'T>

stub methods routeTemplate stub

Full Usage: stub methods routeTemplate stub

Parameters:
Returns: TestClient<'T>
methods : HttpMethod[]
routeTemplate : string
stub : HttpRequestMessage -> RouteValueDictionary -> HttpResponseMessage
Returns: TestClient<'T>

stub_async methods routeTemplate stub

Full Usage: stub_async methods routeTemplate stub

Parameters:
Returns: TestClient<'T>
methods : HttpMethod[]
routeTemplate : string
stub : HttpRequestMessage -> RouteValueDictionary -> Task<HttpResponseMessage>
Returns: TestClient<'T>

stubj methods routeTemplate stub

Full Usage: stubj methods routeTemplate stub

Parameters:
    methods : HttpMethod[]
    routeTemplate : string
    stub : obj

Returns: TestClient<'T>

json stub

methods : HttpMethod[]
routeTemplate : string
stub : obj
Returns: TestClient<'T>

stub_obj methods routeTemplate stub

Full Usage: stub_obj methods routeTemplate stub

Parameters:
Returns: TestClient<'T>

stub operation with stub object (HttpResponseMessage)

methods : HttpMethod[]
routeTemplate : string
stub : unit -> HttpResponseMessage
Returns: TestClient<'T>

stubs methods routeTemplate stub

Full Usage: stubs methods routeTemplate stub

Parameters:
    methods : HttpMethod[]
    routeTemplate : string
    stub : string

Returns: TestClient<'T>

string stub

methods : HttpMethod[]
routeTemplate : string
stub : string
Returns: TestClient<'T>

stub_with_options methods routeTemplate stubAsync useRealHttpClient

Full Usage: stub_with_options methods routeTemplate stubAsync useRealHttpClient

Parameters:
Returns: TestClient<'T>

generic stub operation with stub function

methods : HttpMethod[]
routeTemplate : string
stubAsync : HttpRequestMessage -> RouteValueDictionary -> Task<HttpResponseMessage>
useRealHttpClient : bool
Returns: TestClient<'T>

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: WebApplicationFactory<'T> * DelegatingHandler * ResizeArray<(IServiceCollection -> IServiceCollection)>
() : unit
Returns: WebApplicationFactory<'T> * DelegatingHandler * ResizeArray<(IServiceCollection -> IServiceCollection)>

Type something to start searching.