@b-jones-rfd/sp-rest-connect - v5.1.1
    Preparing search index...

    Type Alias SiteConnectionOptions

    Connection and credential settings for an on-premises SharePoint site (2013, 2016, 2019 or Subscription Edition). SharePoint Online is not supported: it does not accept NTLM authentication.

    type SiteConnectionOptions = {
        agentOptions?: AgentOptions;
        domain?: string;
        hostname?: string;
        password: string;
        protocol?: "https" | "http";
        retry?: RetryOptions;
        serverRelativeUrl: string;
        site: string;
        username: string;
    }
    Index
    agentOptions? domain? hostname? password protocol? retry? serverRelativeUrl site username
    agentOptions?: AgentOptions

    Options for the per-request http.Agent/https.Agent, e.g. ca for an internal certificate authority, rejectUnauthorized, localAddress, or lookup. keepAlive and maxSockets are fixed by the NTLM handshake and cannot be overridden.

    agentOptions: { ca: fs.readFileSync('corp-root-ca.pem') }
    domain?: string

    NTLM (NetBIOS) domain of the account, e.g. 'CONTOSO' — not a DNS name. Leave empty if the account is local to the server.

    ''

    hostname?: string

    Workstation name sent in the NTLM handshake. Rarely needs changing.

    os.hostname()

    password: string

    Password for username. Prefer reading this from the environment rather than hard-coding it.

    protocol?: "https" | "http"

    URL scheme.

    'https'

    retry?: RetryOptions

    Retry transient failures on read actions (get*, check*, iterate*). Off unless set; {} enables the defaults. Write actions are never retried.

    retry: { retries: 3, baseDelayMs: 500 }
    serverRelativeUrl: string

    Server-relative URL of the site (web), starting with / and without a trailing slash (e.g. '/sites/finance'). All folder arguments are resolved relative to this path.

    site: string

    SharePoint host name, without protocol or path (e.g. 'sharepoint.contoso.local').

    username: string

    Windows account name used for NTLM authentication, without the domain (e.g. 'jsmith').

    Settings
    Member Visibility

    On This Page
    Properties