Skip to content

Commit e203b2b

Browse files
authored
Merge pull request #32 from JS-AK/chore/documentation/update
chore: updated docu
2 parents b1562e8 + 012a8e2 commit e203b2b

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

docs/template-fs.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,28 @@ Replaces the content of a specific file in the template.
185185

186186
---
187187

188+
### `from`
189+
190+
Creates a new `TemplateFs` instance from a source Excel file.
191+
192+
- Input:
193+
- `options: object` — configuration object
194+
- `source: string | Buffer` — path to source Excel file or its Buffer content
195+
- `destination: string` — directory path for extracted files
196+
- Output: `Promise<TemplateFs>`
197+
- Preconditions:
198+
- Valid source file/Buffer
199+
- Writable destination path
200+
- Postconditions:
201+
- Files extracted to destination
202+
- Instance ready for use
203+
- Throws if:
204+
- Source file invalid or missing
205+
- Destination path not writable
206+
- Extraction fails
207+
208+
---
209+
188210
## 💡 Usage Examples
189211

190212
### Insert Rows from a Stream and Save to File Stream

docs/template-memory.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,25 @@ Removes worksheets from the workbook.
201201

202202
---
203203

204+
### `from`
205+
206+
Creates a new `TemplateMemory` instance from a source Excel file.
207+
208+
- Input:
209+
- `options: object` — configuration object
210+
- `source: string | Buffer` — path to source Excel file or its Buffer content
211+
- Output: `Promise<TemplateMemory>`
212+
- Preconditions:
213+
- Valid source file/Buffer
214+
- Postconditions:
215+
- Files loaded into memory
216+
- Instance ready for use
217+
- Throws if:
218+
- Source file invalid or missing
219+
- File parsing fails
220+
221+
---
222+
204223
## 💡 Usage Examples
205224

206225
### Create from File and Modify

0 commit comments

Comments
 (0)