Skip to content

Commit a076225

Browse files
Jon ChristensenJon Christensen
authored andcommitted
Docs. Merges...
1 parent 42af1ad commit a076225

File tree

2 files changed

+36
-4
lines changed

2 files changed

+36
-4
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2049,6 +2049,17 @@ Logger.log(arrForColRange(range_vafro)); // ["A", "B", "C", "D"]
20492049
##### Create or Verify Document in a Folder #####
20502050

20512051
```javascript
2052+
// --- Create or Verify Document in a Folder
2053+
2054+
/**
2055+
* Returns a document.
2056+
* This creates the document if it does not already exist.
2057+
*
2058+
* @param {Folder} fldr
2059+
* @param {string} name
2060+
* @returns {Document}
2061+
*/
2062+
20522063
function createVerifyDocIn(fldr, name) {
20532064
var files = filesIn(fldr);
20542065
var names = fileNames(files);
@@ -2057,16 +2068,24 @@ function createVerifyDocIn(fldr, name) {
20572068
var file = DriveApp.getFileById(doc);
20582069
moveFile(file, fldr);
20592070
}
2060-
return findFileIn(fldr, name);
2071+
return openFileAsDocument(findFileIn(fldr, name));
20612072
}
20622073

2063-
var fldr_cvdi = createVerifyPath("google-apps-script-cheat-sheet/docs");
2074+
var fldr_cvdi = createVerifyPath("google-apps-script-cheat-sheet-demo/docs");
20642075
Logger.log(createVerifyDocIn(fldr_cvdi, "example-doc")); // example-doc
20652076
```
20662077

20672078
##### Create or Verify Document at Root #####
20682079

20692080
```javascript
2081+
/**
2082+
* Returns a document.
2083+
* This creates the document if it does not already exist.
2084+
*
2085+
* @param {string} name
2086+
* @returns {Document}
2087+
*/
2088+
20702089
function createVerifyDocAtRoot(name) {
20712090
var files = rootFiles();
20722091
var names = fileNames(files);
@@ -2080,6 +2099,12 @@ function createVerifyDocAtRoot(name) {
20802099
#### Id of Active Document ####
20812100

20822101
```javascript
2102+
/**
2103+
* Returns the Id of the active document.
2104+
*
2105+
* @returns {string}
2106+
*/
2107+
20832108
function docId() {
20842109
var _id = DocumentApp.getActiveDocument().getId();
20852110
return _id;
@@ -2089,13 +2114,20 @@ function docId() {
20892114
#### Open File as Document ####
20902115

20912116
```javascript
2117+
/**
2118+
* Returns a file as a document.
2119+
*
2120+
* @param {File} file
2121+
* @returns {Document}
2122+
*/
2123+
20922124
function openFileAsDocument(file) {
20932125
var _id = file.getId();
20942126
var _doc = DocumentApp.openById(_id);
20952127
return _doc;
20962128
}
20972129

2098-
var fldr_ofad = lastFolderIn("google-apps-script-cheat-sheet-demo/docs")
2130+
var fldr_ofad = lastFolderIn("google-apps-script-cheat-sheet-demo/docs");
20992131
var file_ofad = findFileIn(fldr_ofad, "example-doc");
21002132
Logger.log(openFileAsDocument(file_ofad));
21012133
```

main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1909,7 +1909,7 @@ function arrForColRange(rangeObj){
19091909

19101910
// - Managing Document Files
19111911

1912-
// -- Create or Verify Document in a Folder or at Root
1912+
// -- Create or Verify Document
19131913

19141914
// --- Create or Verify Document in a Folder
19151915

0 commit comments

Comments
 (0)