Interface CurlyFunction

interface CurlyFunction {
    acl: CurlyHttpMethodCall;
    bind: CurlyHttpMethodCall;
    checkout: CurlyHttpMethodCall;
    connect: CurlyHttpMethodCall;
    copy: CurlyHttpMethodCall;
    create: (defaultOptions?: CurlyOptions) => CurlyFunction;
    defaultResponseBodyParsers: CurlyResponseBodyParsersProperty;
    delete: CurlyHttpMethodCall;
    get: CurlyHttpMethodCall;
    head: CurlyHttpMethodCall;
    link: CurlyHttpMethodCall;
    lock: CurlyHttpMethodCall;
    "m-search": CurlyHttpMethodCall;
    merge: CurlyHttpMethodCall;
    mkactivity: CurlyHttpMethodCall;
    mkcalendar: CurlyHttpMethodCall;
    mkcol: CurlyHttpMethodCall;
    move: CurlyHttpMethodCall;
    notify: CurlyHttpMethodCall;
    options: CurlyHttpMethodCall;
    patch: CurlyHttpMethodCall;
    post: CurlyHttpMethodCall;
    propfind: CurlyHttpMethodCall;
    proppatch: CurlyHttpMethodCall;
    purge: CurlyHttpMethodCall;
    put: CurlyHttpMethodCall;
    rebind: CurlyHttpMethodCall;
    report: CurlyHttpMethodCall;
    search: CurlyHttpMethodCall;
    source: CurlyHttpMethodCall;
    subscribe: CurlyHttpMethodCall;
    trace: CurlyHttpMethodCall;
    unbind: CurlyHttpMethodCall;
    unlink: CurlyHttpMethodCall;
    unlock: CurlyHttpMethodCall;
    unsubscribe: CurlyHttpMethodCall;
    <ResultData = any>(
        url: string,
        options?: CurlyOptions,
    ): Promise<CurlyResult<ResultData>>;
}

Hierarchy

  • HttpMethodCalls
    • CurlyFunction
  • CurlyFunction<ResultData = any>(
        url: string,
        options?: CurlyOptions,
    ): Promise<CurlyResult<ResultData>>

  • EXPERIMENTAL This API can change between minor releases

    Async wrapper around the Curl class.

    It's also possible to request using a specific http verb directly by using curl.<http-verb>(url: string, options?: CurlyOptions), like:

    curly.get('https://www.google.com')

    Type Parameters

    • ResultData = any

      You can use this to specify the type of the data property returned from this call.

    Parameters

    • url: string
    • Optionaloptions: CurlyOptions

    Returns Promise<CurlyResult<ResultData>>

Properties

acl bind checkout connect copy create defaultResponseBodyParsers delete get head link lock m-search merge mkactivity mkcalendar mkcol move notify options patch post propfind proppatch purge put rebind report search source subscribe trace unbind unlink unlock unsubscribe

Properties

acl

acl: CurlyHttpMethodCall

bind

bind: CurlyHttpMethodCall

checkout

checkout: CurlyHttpMethodCall

connect

connect: CurlyHttpMethodCall

copy

copy: CurlyHttpMethodCall

create

create: (defaultOptions?: CurlyOptions) => CurlyFunction

EXPERIMENTAL This API can change between minor releases

This returns a new curly with the specified options set by default.

defaultResponseBodyParsers

defaultResponseBodyParsers: CurlyResponseBodyParsersProperty

These are the default response body parsers to be used.

By default there are parsers for the following:

  • application/json
  • text/*

delete

delete: CurlyHttpMethodCall

get

get: CurlyHttpMethodCall

head

head: CurlyHttpMethodCall

link

link: CurlyHttpMethodCall

lock

lock: CurlyHttpMethodCall

m-search

"m-search": CurlyHttpMethodCall

merge

merge: CurlyHttpMethodCall

mkactivity

mkactivity: CurlyHttpMethodCall

mkcalendar

mkcalendar: CurlyHttpMethodCall

mkcol

mkcol: CurlyHttpMethodCall

move

move: CurlyHttpMethodCall

notify

notify: CurlyHttpMethodCall

options

options: CurlyHttpMethodCall

patch

patch: CurlyHttpMethodCall

post

post: CurlyHttpMethodCall

propfind

propfind: CurlyHttpMethodCall

proppatch

proppatch: CurlyHttpMethodCall

purge

purge: CurlyHttpMethodCall

put

put: CurlyHttpMethodCall

rebind

rebind: CurlyHttpMethodCall

report

report: CurlyHttpMethodCall

search

search: CurlyHttpMethodCall

source

source: CurlyHttpMethodCall

subscribe

subscribe: CurlyHttpMethodCall

trace

trace: CurlyHttpMethodCall

unbind

unbind: CurlyHttpMethodCall

unlink

unlink: CurlyHttpMethodCall

unlock

unlock: CurlyHttpMethodCall

unsubscribe

unsubscribe: CurlyHttpMethodCall

Settings

Member Visibility

On This Page

Properties