Skip to content

Commit fe10875

Browse files
uttamukkojiuttamukkoji
committed
docs: 📝 Update Embedded-Items reference
1 parent 2a870f8 commit fe10875

9 files changed

Lines changed: 51 additions & 142 deletions

File tree

‎dist/nativescript/contentstack.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/react-native/contentstack.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎js-sdk-reference/Contentstack.html‎

Lines changed: 0 additions & 110 deletions
Original file line numberDiff line numberDiff line change
@@ -213,116 +213,6 @@ <h5>Example</h5>
213213

214214

215215

216-
217-
<h4 class="name" id=".render"><span class="type-signature">(static) </span>render<span class="type-signature"></span></h4>
218-
219-
220-
221-
222-
<div class="description">
223-
Renders embedded objects in Rich text from Entry or Multiple Entry Object.
224-
</div>
225-
226-
227-
228-
229-
230-
231-
232-
<dl class="details">
233-
234-
235-
236-
237-
238-
239-
240-
241-
242-
243-
244-
245-
246-
247-
248-
249-
250-
251-
252-
253-
254-
255-
256-
257-
258-
259-
260-
261-
262-
263-
</dl>
264-
265-
266-
267-
268-
269-
270-
271-
272-
<h4 class="name" id=".renderContent"><span class="type-signature">(static) </span>renderContent<span class="type-signature"></span></h4>
273-
274-
275-
276-
277-
<div class="description">
278-
Renders embedded objects in Rich text from String or String of array.
279-
</div>
280-
281-
282-
283-
284-
285-
286-
287-
<dl class="details">
288-
289-
290-
291-
292-
293-
294-
295-
296-
297-
298-
299-
300-
301-
302-
303-
304-
305-
306-
307-
308-
309-
310-
311-
312-
313-
314-
315-
316-
317-
318-
</dl>
319-
320-
321-
322-
323-
324-
325-
326216

327217

328218

‎js-sdk-reference/Entry.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1098,7 +1098,7 @@ <h4 class="name" id="includeEmbeddedItems"><span class="type-signature"></span>i
10981098

10991099
<h5>Example</h5>
11001100

1101-
<pre class="prettyprint"><code>Stack.ContentType("contentType_uid").Entry("entry_uid").includeEmbeddedObjects().fetch()</code></pre>
1101+
<pre class="prettyprint"><code>Stack.ContentType("contentType_uid").Entry("entry_uid").includeEmbeddedItems().fetch()</code></pre>
11021102

11031103

11041104

‎js-sdk-reference/Stack.html‎

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h2>
6464

6565

6666

67-
<h4 class="name" id="Stack"><span class="type-signature"></span>new Stack<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Stack.html">Stack</a>}</span></h4>
67+
<h4 class="name" id="Stack"><span class="type-signature"></span>new Stack<span class="signature">(stack)</span><span class="type-signature"> &rarr; {<a href="Stack.html">Stack</a>}</span></h4>
6868

6969

7070

@@ -105,7 +105,38 @@ <h5>Parameters:</h5>
105105

106106
<tr>
107107

108-
<td class="name"><code>stack.api_key</code></td>
108+
<td class="name"><code>stack</code></td>
109+
110+
111+
112+
113+
114+
115+
<td class="description last">Stack Details
116+
<h6>Properties</h6>
117+
118+
119+
<table class="params">
120+
<thead>
121+
<tr>
122+
123+
<th>Name</th>
124+
125+
126+
127+
128+
129+
130+
<th class="last">Description</th>
131+
</tr>
132+
</thead>
133+
134+
<tbody>
135+
136+
137+
<tr>
138+
139+
<td class="name"><code>api_key</code></td>
109140

110141

111142

@@ -119,7 +150,7 @@ <h5>Parameters:</h5>
119150

120151
<tr>
121152

122-
<td class="name"><code>stack.delivery_token</code></td>
153+
<td class="name"><code>delivery_token</code></td>
123154

124155

125156

@@ -133,7 +164,7 @@ <h5>Parameters:</h5>
133164

134165
<tr>
135166

136-
<td class="name"><code>stack.environment</code></td>
167+
<td class="name"><code>environment</code></td>
137168

138169

139170

@@ -147,7 +178,7 @@ <h5>Parameters:</h5>
147178

148179
<tr>
149180

150-
<td class="name"><code>stack.region</code></td>
181+
<td class="name"><code>region</code></td>
151182

152183

153184

@@ -161,7 +192,7 @@ <h5>Parameters:</h5>
161192

162193
<tr>
163194

164-
<td class="name"><code>stack.fetchOptions</code></td>
195+
<td class="name"><code>fetchOptions</code></td>
165196

166197

167198

@@ -283,6 +314,13 @@ <h6>Properties</h6>
283314
</tbody>
284315
</table>
285316

317+
</td>
318+
</tr>
319+
320+
321+
</tbody>
322+
</table>
323+
286324

287325

288326

‎js-sdk-reference/contentstack.js.html‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ <h1 class="page-title">contentstack.js</h1>
5050
<pre class="prettyprint source linenums"><code>import Stack from "./stack";
5151
import CacheProvider from './cache-provider/index';
5252
import ContentstackRegion from "./contentstackregion";
53-
import {render , renderContent} from '@contentstack/utils';
5453

5554
/**
5655
* @class
@@ -75,25 +74,7 @@ <h1 class="page-title">contentstack.js</h1>
7574
this.CachePolicy = CacheProvider.policies;
7675
this.Region = ContentstackRegion;
7776

78-
this.Utils = {
79-
/**
80-
* @memberof Contentstack
81-
* @description Renders embedded objects in Rich text from Entry or Multiple Entry Object.
82-
*
83-
* @param {EntryEmbedable| EntryEmbedable[]} entry - Objects that contains RTE with embedded objects
84-
* @param {string[]} keyPaths - Key paths for RTE contents in Entry object
85-
* @param {RenderOption?} renderOption - Optional render options to render content
86-
*/
87-
render,
88-
/**
89-
* @memberof Contentstack
90-
* @description Renders embedded objects in Rich text from String or String of array.
91-
* @param {string | string[]} content - RTE content to render
92-
* @param {EntryEmbedable} options.entry - Entry object containing embedded objects
93-
* @param {RenderOption?} options.renderOption - Optional render options to render content
94-
*/
95-
renderContent
96-
}
77+
this.Utils = require('@contentstack/utils');
9778
}
9879
/**
9980

‎js-sdk-reference/modules_entry.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ <h1 class="page-title">modules/entry.js</h1>
237237
* @method includeEmbeddedItems
238238
* @memberOf Entry
239239
* @description Include Embedded Objects (Entries and Assets) along with entry/entries details.
240-
* @example Stack.ContentType("contentType_uid").Entry("entry_uid").includeEmbeddedObjects().fetch()
240+
* @example Stack.ContentType("contentType_uid").Entry("entry_uid").includeEmbeddedItems().fetch()
241241
* @returns {Entry}
242242
* @instance
243243
*/

‎js-sdk-reference/stack.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h1 class="page-title">stack.js</h1>
6060
* @class
6161
Stack
6262
* @description Initialize an instance of ‘Stack’
63-
63+
* @param {Object} stack - Stack Details
6464
* @param {String} stack.api_key - Stack API Key.
6565
* @param {String} stack.delivery_token - Stack Delivery token.
6666
* @param {String} stack.environment - Stack Environment name.

‎src/core/modules/entry.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ export default class Entry {
188188
* @method includeEmbeddedItems
189189
* @memberOf Entry
190190
* @description Include Embedded Objects (Entries and Assets) along with entry/entries details.
191-
* @example Stack.ContentType("contentType_uid").Entry("entry_uid").includeEmbeddedObjects().fetch()
191+
* @example Stack.ContentType("contentType_uid").Entry("entry_uid").includeEmbeddedItems().fetch()
192192
* @returns {Entry}
193193
* @instance
194194
*/

0 commit comments

Comments
 (0)