@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(). |
RootServiceKey |
The RootServiceKey is a lookup key that is used when calling ServiceScope.consume() to fetch a dependency that is ever expected to only be created or provided once. |
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. |
SPError |
The purpose of this class is to help make the SharePoint framework errors more robust. On top of the base Error class functionality, this class adds the concept of error codes. The error code could be a non-localized immutable string or an error number. All the SharePoint framework code is expected to use this class for raising errors. References: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error http://stackoverflow.com/questions/1382107/whats-a-good-way-to-extend-error-in-javascript |
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. |
UrlUtilities |
Common helper functions for working with URLs. These utilities are intended to be simple, small, and very broadly applicable. |
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. |
ILogHandler |
The redirectable implementation for the Log class. |
IRandomNumberGenerator |
This is a ServiceScope contract for generating pseudorandom random numbers. |
IServiceCollection |
A shorthand pattern for extracting well-known services from a ServiceScope. |
IServiceKey |
The ServiceKey is a lookup key that is used when calling ServiceScope.consume() to fetch a dependency. |
IServiceScope |
The service locator pattern used by the SharePoint Framework. |
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 |
_NextValue |
Utility type to get the next value for a recursive conditional evaluation. |
_RecursivelyExtractFromSet |
Utility type to recursively evaluate if |
_Stop |
Utility type to evaluate if a recursive conditional evaluation should stop. |
_UniqueCondition |
Utility type to evaluate if |
_UniqueFromSet |
Utility type to recursively evaluate if |
EnsureExtends |
Utility type to ensure that |
ExtractFromSet |
Utility type to extract |
IsStringUnion |
Helper type to determine if a type is a string union. |
IsUnion |
Helper type to determine if a type is a union. |
ServiceClass |
This is a type definition for the Service. |
ServiceClassConstructor |
This is a constructor definition for the Service isntance. |
ServiceCreator |
This is a callback that is used by ServiceKey.createCustom(). |
StringUnion |
Helper type to extract a string union from a type. |
UnionToIntersection |
Helper type to convert a union to an intersection. |
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 |