Skip to content

Commit 1de6c86

Browse files
suramamsuramam
suramam
authored and
suramam
committed
Merge branch 'reference' of https://github.com/SharePoint/sp-dev-docs into reference
2 parents 5681738 + fc41303 commit 1de6c86

File tree

129 files changed

+6680
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+6680
-4
lines changed

‎misc/SharePointReferenceToc.xml

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<Menu xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" SupportedProduct="|SharePoint" SupportedVersion="|V1.0|">
3-
<Item text="SharePoint Framework Reference" url="sharepoint-framework-reference" SEODescription="Reference documentation for the SharePoint Framework"/>
3+
<Item text="SharePoint Framework Reference" url="spfx" SEODescription="Reference documentation for the SharePoint Framework">
4+
<Item text="sp-client-base module" url="spfx/sp-client-base" SEODescription="">
5+
<Item text="BasicHttpClient class" url="spfx/sp-client-base/basichttpclient" SEODescription=""/>
6+
<Item text="Compare class" url="spfx/sp-client-base/compare" SEODescription=""/>
7+
</Item>
8+
<Item text="sp-client-preview" url="spfx/sp-client-preview" SEODescription="">
9+
<Item text="BaseClientSideWebPart class" url="spfx/sp-client-preview/baseclientsidewebpart" SEODescription=""/>
10+
<Item text="MockWebPartContext class" url="spfx/sp-client-preview/mockwebpartcontext" SEODescription=""/>
11+
</Item>
12+
<Item text="sp-module-interfaces module" url="spfx/sp-module-interfaces" SEODescription="">
13+
<Item text="IBundleReference interface" url="spfx/sp-module-interfaces/ibundlereference" SEODescription=""/>
14+
<Item text="IClientSideComponentLoaderConfig interface" url="spfx/sp-module-interfaces/iclientsidecomponentloaderconfig" SEODescription=""/>
15+
</Item>
16+
<Item text="es6-collections module" url="spfx/es6-collections" SEODescription="">
17+
<Item text="ForEachable interface" url="spfx/es6-collections/foreachable" SEODescription=""/>
18+
<Item text="WeakMap interface" url="spfx/es6-collections/weakmap" SEODescription=""/>
19+
</Item>
20+
<Item text="es6-promise module" url="spfx/es6-promise" SEODescription="">
21+
<Item text="Promise module" url="spfx/es6-promise/promise-imodule" SEODescription=""/>
22+
<Item text="Promise class" url="spfx/es6-promise/promise" SEODescription=""/>
23+
<Item text="Thenable interface" url="spfx/es6-promise/thenable" SEODescription=""/>
24+
</Item>
25+
<Item text="whatwg-fetch module" url="spfx/whatwg-fetch" SEODescription="">
26+
<Item text="Request class" url="spfx/whatwg-fetch/request" SEODescription=""/>
27+
<Item text="Headers class" url="spfx/whatwg-fetch/headers" SEODescription=""/>
28+
</Item>
29+
</Item>
430
</Menu>
5-

‎reference/sharepoint-framework-reference.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎reference/spfx.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# SharePoint Framework Reference
2+
3+
## Modules
4+
5+
| Module | Description|
6+
|:-------------|:-------|
7+
|[sp-client-base](./spfx/sp-client-base/sp-client-base-module.md)||
8+
|[sp-client-preview](./spfx/sp-client-preview/sp-client-preview-module.md)||
9+
|[sp-module-interfaces](./spfx/sp-module-interfaces/sp-module-interfaces-module.md)||
10+
|[typings/es6-collections](./spfx/es6-collections/es6-collections-module.md)||
11+
|[typings/es6-promise](./spfx/es6-promise/es6-promise-module.md)||
12+
|[typings/whatwg-fetch](./spfx/whatwg-fetch/whatwg-fetch-module.md)||

‎reference/spfx/es6-collections.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# es6-collections external module
2+
3+
4+
## Modules
5+
6+
| Module | Description |
7+
|:-------------|:---------------|
8+
| [es6-collections](es6-collections-imodule.md) | |
9+
10+
11+
12+
13+
## Interfaces
14+
15+
| Interface | Description |
16+
|:-------------|:---------------|
17+
| [IteratorResult](iteratorresult.md) | |
18+
| [Iterator](iterator.md) | |
19+
| [ForEachable](foreachable.md) | |
20+
| [Map](map.md) | |
21+
| [MapConstructor](mapconstructor.md) | |
22+
| [Set](set.md) | |
23+
| [SetConstructor](setconstructor.md) | |
24+
| [WeakMap](weakmap.md) | |
25+
| [WeakMapConstructor](weakmapconstructor.md) | |
26+
| [WeakSet](weakset.md) | |
27+
| [WeakSetConstructor](weaksetconstructor.md) | |
28+
29+
30+
31+
32+
33+
34+
### Variables
35+
36+
| Variable | Type|
37+
|:-----------|:------------|
38+
|Map | [`MapConstructor`](../es6-collections/mapconstructor.md) |
39+
|Set | [`SetConstructor`](../es6-collections/setconstructor.md) |
40+
|WeakMap | [`WeakMapConstructor`](../es6-collections/weakmapconstructor.md) |
41+
|WeakSet | [`WeakSetConstructor`](../es6-collections/weaksetconstructor.md) |
42+

‎reference/spfx/es6-collections/es6-collections-imodule.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# es6-collections module
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
17+
## Variables
18+
19+
| Variable | Description|
20+
|:-------------|:----|
21+
|Map | |
22+
|Set | |
23+
|WeakMap | |
24+
|WeakSet | |
25+

‎reference/spfx/es6-collections/foreachable.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# ForEachable interface
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
## Methods
16+
17+
| Method | Returns | Description|
18+
|:-------------|:-------|:-----------|
19+
|[`forEach`](#foreach) | `void` | |
20+
21+
22+
23+
24+
### forEach
25+
26+
27+
28+
#### Signature
29+
`forEach(callbackfn: (value: T) => void): void`
30+
31+
#### Returns
32+
`void`
33+
34+
35+
#### Parameters
36+
37+
38+
| Parameter | Type | Description |
39+
|:-------------|:---------------|:------------|
40+
| `callbackfn` | `(value: T) => void` | |
41+

‎reference/spfx/es6-collections/iterator.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Iterator interface
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
## Methods
16+
17+
| Method | Returns | Description|
18+
|:-------------|:-------|:-----------|
19+
|[`next`](#next) | [`IteratorResult<T>`](../es6-collections/iteratorresult.md) | |
20+
|[`return`](#return) | [`IteratorResult<T>`](../es6-collections/iteratorresult.md) | |
21+
|[`throw`](#throw) | [`IteratorResult<T>`](../es6-collections/iteratorresult.md) | |
22+
23+
24+
25+
26+
### next
27+
28+
29+
30+
#### Signature
31+
`next(value?: any): IteratorResult<T>`
32+
33+
#### Returns
34+
[`IteratorResult<T>`](../es6-collections/iteratorresult.md)
35+
36+
37+
#### Parameters
38+
39+
40+
| Parameter | Type | Description |
41+
|:-------------|:---------------|:------------|
42+
| `value` | `any` | _Optional._ |
43+
44+
45+
### return
46+
47+
48+
49+
#### Signature
50+
`return?(value?: any): IteratorResult<T>`
51+
52+
#### Returns
53+
[`IteratorResult<T>`](../es6-collections/iteratorresult.md)
54+
55+
56+
#### Parameters
57+
58+
59+
| Parameter | Type | Description |
60+
|:-------------|:---------------|:------------|
61+
| `value` | `any` | _Optional._ |
62+
63+
64+
### throw
65+
66+
67+
68+
#### Signature
69+
`throw?(e?: any): IteratorResult<T>`
70+
71+
#### Returns
72+
[`IteratorResult<T>`](../es6-collections/iteratorresult.md)
73+
74+
75+
#### Parameters
76+
77+
78+
| Parameter | Type | Description |
79+
|:-------------|:---------------|:------------|
80+
| `e` | `any` | _Optional._ |
81+

‎reference/spfx/es6-collections/iteratorresult.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# IteratorResult interface
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
### Properties
13+
14+
| Property | Type | Description|
15+
|:-------------|:-------|:-----------|
16+
|`done` | `boolean` | |
17+
|`value` | `T` | |
18+
19+
20+
21+
22+

0 commit comments

Comments
 (0)