1.0.3 • Published 8 years ago

sp-context-helper v1.0.3

Weekly downloads
5
License
MIT
Repository
github
Last release
8 years ago

sp-context-helper Build Status

Get associated SP.Web and SP.Site by url.

Installation

npm install sp-context-helper --save

Usage

JavaScript

import { contextHelper } from 'sp-context-helper';

let contextWrapper = contextHelper('web url');

TypeScript

typings install dt~microsoft.ajax --global --save
typings install dt~sharepoint --global --save
/// <reference path="./typings/index.d.ts"/>

import { contextHelper, IContextWrapper } from 'sp-context-helper';

let contextWrapper: IContextWrapper = contextHelper('web url');

API

interface IContextWrapper {
    web: SP.Web;
    site: SP.Site;
    clientContext: SP.ClientContext;
    appContextSite: SP.AppContextSite;
}

contextHelper(webUrl?: string, isAppContextSite?: boolean): IContextWrapper

To query current web, use contextHelper(), to query host web, use contextHelper('host url', true), to query web in same domain, use contextHelper('web url').

License

MIT.