@microsoft/sp-core-library package

SharePoint Framework core libraries.

Classes

Environment

Information about the system environment where the SharePoint Framework is running.

Guid

This class represents a globally unique identifier, as described by IETF RFC 4122.

Log

A basic redirectable logging system.

RandomNumberGenerator

This is the default implementation of IRandomNumberGenerator that simply calls Math.random().

ServiceKey

The ServiceKey is a lookup key that is used when calling ServiceScope.consume() to fetch a dependency.

ServiceScope

The service locator pattern used by the SharePoint Framework.

Session

Provides access to the application's browser session and active page.

SPEvent

Represents a framework event that components can subscribe to.

SPEventArgs

The base class for event arguments used with the SPEvent class.

Text_2

Operations for working with strings that contain text.

TimeProvider

This is the default implementation of ITimeProvider that simply calls the real browser APIs.

UrlQueryParameterCollection

Provides features for storing and retrieving URL query parameters.

Validate

Performs common validation tests for properties and function parameters.

Version

Represents a version number with two, three, or four parts.

Interfaces

IDisposable

Implemented by an object that supports a disposal lifecycle.

IRandomNumberGenerator

This is a ServiceScope contract for generating pseudorandom random numbers.

IServiceCollection

A shorthand pattern for extracting well-known services from a ServiceScope.

ISPEventObserver

Used with the SPEvent system, this interface is implemented by components that can subscribe to events.

ITimeProvider

This is a ServiceScope contract for reading the system clock.

Type Aliases

_ContinueRecursivelyExtractFromSet

Utility type to evaluate if _RecursivelyExtractFromSet should continue recursion.

_IsNever

Utility type to check if Type is never.

_NextValue

Utility type to get the next value for a recursive conditional evaluation.

_RecursivelyExtractFromSet

Utility type to recursively evaluate if Type is within Set.

_Stop

Utility type to evaluate if a recursive conditional evaluation should stop.

_UniqueCondition

Utility type to evaluate if Type1 and Type2 are the same.

_UniqueFromSet

Utility type to recursively evaluate if Type is within Set.

ExtractFromSet

Utility type to extract Type from Set if and only if Type is in Set.

ServiceCreator

This is a callback that is used by ServiceKey.createCustom().

Enums

DisplayMode

Indicates whether a visual control should display itself for reading or for editing.

EnvironmentType

Indicates the general type of environment where the SharePoint Framework is running.

FormDisplayMode