Skip to content

Commit d64f799

Browse files
authored
Editorial: modernize method definitions
See #64.
1 parent b345282 commit d64f799

File tree

1 file changed

+21
-37
lines changed

1 file changed

+21
-37
lines changed

index.bs

Lines changed: 21 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ associated [=FileSystemHandle/entry=].
244244
</div>
245245

246246
<div algorithm>
247-
The <dfn method for=FileSystemHandle>isSameEntry(|other|)</dfn> method, when invoked, must run these steps:
247+
The <dfn method for=FileSystemHandle>isSameEntry(|other|)</dfn> method steps are:
248248

249249
1. Let |realm| be [=this=]'s [=relevant Realm=].
250250
1. Let |p| be [=a new promise=] in |realm|.
@@ -287,7 +287,7 @@ A {{FileSystemFileHandle}}'s associated [=FileSystemHandle/entry=] must be a [=f
287287
</div>
288288

289289
<div algorithm>
290-
The <dfn method for=FileSystemFileHandle>getFile()</dfn> method, when invoked, must run these steps:
290+
The <dfn method for=FileSystemFileHandle>getFile()</dfn> method steps are:
291291

292292
1. Let |result| be [=a new promise=].
293293
1. Run the following steps [=in parallel=]:
@@ -341,7 +341,7 @@ combine the desire to run malware checks with the desire to let websites make fa
341341
modifications to existing large files.
342342

343343
<div algorithm>
344-
The <dfn method for=FileSystemFileHandle>createWritable(|options|)</dfn> method, when invoked, must run these steps:
344+
The <dfn method for=FileSystemFileHandle>createWritable(|options|)</dfn> method steps are:
345345

346346
1. Let |result| be [=a new promise=].
347347
1. Run the following steps [=in parallel=]:
@@ -383,7 +383,7 @@ The <dfn method for=FileSystemFileHandle>createWritable(|options|)</dfn> method,
383383
</div>
384384

385385
<div algorithm>
386-
The <dfn method for=FileSystemFileHandle>createSyncAccessHandle()</dfn> method, when invoked, must run these steps:
386+
The <dfn method for=FileSystemFileHandle>createSyncAccessHandle()</dfn> method steps are:
387387

388388
1. Let |result| be [=a new promise=].
389389
1. Run the following steps [=in parallel=]:
@@ -526,8 +526,7 @@ and its async iterator |iterator|:
526526
</div>
527527

528528
<div algorithm>
529-
The <dfn method for=FileSystemDirectoryHandle>getFileHandle(|name|, |options|)</dfn> method, when invoked,
530-
must run these steps:
529+
The <dfn method for=FileSystemDirectoryHandle>getFileHandle(|name|, |options|)</dfn> method steps are:
531530

532531
1. Let |result| be [=a new promise=].
533532
1. Run the following steps [=in parallel=]:
@@ -588,8 +587,7 @@ must run these steps:
588587
</div>
589588

590589
<div algorithm>
591-
The <dfn method for=FileSystemDirectoryHandle>getDirectoryHandle(|name|, |options|)</dfn> method, when
592-
invoked, must run these steps:
590+
The <dfn method for=FileSystemDirectoryHandle>getDirectoryHandle(|name|, |options|)</dfn> method steps are:
593591

594592
1. Let |result| be [=a new promise=].
595593
1. Run the following steps [=in parallel=]:
@@ -647,8 +645,7 @@ invoked, must run these steps:
647645
</div>
648646

649647
<div algorithm>
650-
The <dfn method for=FileSystemDirectoryHandle>removeEntry(|name|, |options|)</dfn> method, when invoked, must run
651-
these steps:
648+
The <dfn method for=FileSystemDirectoryHandle>removeEntry(|name|, |options|)</dfn> method steps are:
652649

653650
1. Let |result| be [=a new promise=].
654651
1. Run the following steps [=in parallel=]:
@@ -727,14 +724,12 @@ if (relative_path === null) {
727724
</div>
728725

729726
<div algorithm>
730-
The <dfn method for=FileSystemDirectoryHandle>resolve(|possibleDescendant|)</dfn> method,
731-
when invoked, must return the result of [=entry/resolving=]
732-
|possibleDescendant|'s [=FileSystemHandle/entry=] relative to [=this=]'s [=FileSystemHandle/entry=].
727+
The <dfn method for=FileSystemDirectoryHandle>resolve(|possibleDescendant|)</dfn> method steps are
728+
to return the result of [=entry/resolving=]|possibleDescendant|'s [=FileSystemHandle/entry=]
729+
relative to [=this=]'s [=FileSystemHandle/entry=].
733730

734731
</div>
735732

736-
737-
738733
## The {{FileSystemWritableFileStream}} interface ## {#api-filesystemwritablefilestream}
739734

740735
<xmp class=idl>
@@ -960,8 +955,7 @@ runs these steps:
960955
</div>
961956

962957
<div algorithm>
963-
The <dfn method for=FileSystemWritableFileStream>write(|data|)</dfn> method, when invoked, must run
964-
these steps:
958+
The <dfn method for=FileSystemWritableFileStream>write(|data|)</dfn> method steps are:
965959

966960
1. Let |writer| be the result of [=WritableStream/getting a writer=] for [=this=].
967961
1. Let |result| be the result of [=WritableStreamDefaultWriter/writing a chunk=] to |writer| given
@@ -979,8 +973,7 @@ these steps:
979973
</div>
980974

981975
<div algorithm>
982-
The <dfn method for=FileSystemWritableFileStream>seek(|position|)</dfn> method, when invoked, must run these
983-
steps:
976+
The <dfn method for=FileSystemWritableFileStream>seek(|position|)</dfn> method steps are:
984977

985978
1. Let |writer| be the result of [=WritableStream/getting a writer=] for [=this=].
986979
1. Let |result| be the result of [=WritableStreamDefaultWriter/writing a chunk=] to |writer| given
@@ -1007,8 +1000,7 @@ steps:
10071000
</div>
10081001

10091002
<div algorithm>
1010-
The <dfn method for=FileSystemWritableFileStream>truncate(|size|)</dfn> method, when invoked, must run these
1011-
steps:
1003+
The <dfn method for=FileSystemWritableFileStream>truncate(|size|)</dfn> method steps are:
10121004

10131005
1. Let |writer| be the result of [=WritableStream/getting a writer=] for [=this=].
10141006
1. Let |result| be the result of [=WritableStreamDefaultWriter/writing a chunk=] to |writer| given
@@ -1075,8 +1067,7 @@ in a [=/Realm=] |realm|, perform the following steps:
10751067

10761068
// TODO(fivedots): Specify how Access Handles should react when reading from a file that has been modified externally.
10771069
<div algorithm>
1078-
The <dfn method for=FileSystemSyncAccessHandle>read(|buffer|, {{FileSystemReadWriteOptions}}: |options|)</dfn> method, when invoked, must run
1079-
these steps:
1070+
The <dfn method for=FileSystemSyncAccessHandle>read(|buffer|, {{FileSystemReadWriteOptions}}: |options|)</dfn> method steps are:
10801071

10811072
1. If [=this=].[=[[state]]=] is "`closed`", throw an {{InvalidStateError}}.
10821073
1. Let |bufferSize| be |buffer|'s [=byte length=].
@@ -1109,8 +1100,7 @@ these steps:
11091100

11101101
// TODO(fivedots): Figure out how to properly check the available storage quota (in this method and others) by passing the right storage shelf.
11111102
<div algorithm>
1112-
The <dfn method for=FileSystemSyncAccessHandle>write(|buffer|, {{FileSystemReadWriteOptions}}: |options|)</dfn> method, when invoked, must run
1113-
these steps:
1103+
The <dfn method for=FileSystemSyncAccessHandle>write(|buffer|, {{FileSystemReadWriteOptions}}: |options|)</dfn> method steps are:
11141104

11151105
1. If [=this=].[=[[state]]=] is "`closed`", throw an {{InvalidStateError}}.
11161106
1. Let |writePosition| be |options|.{{FileSystemReadWriteOptions/at}}.
@@ -1156,8 +1146,7 @@ these steps:
11561146
</div>
11571147

11581148
<div algorithm>
1159-
The <dfn method for=FileSystemSyncAccessHandle>truncate(|newSize|)</dfn> method, when invoked, must run
1160-
these steps:
1149+
The <dfn method for=FileSystemSyncAccessHandle>truncate(|newSize|)</dfn> method steps are:
11611150

11621151
1. If [=this=].[=[[state]]=] is "`closed`", throw an {{InvalidStateError}}.
11631152
1. Let |fileContents| be a copy of [=this=].[=FileSystemSyncAccessHandle/[[file]]=]'s [=file entry/binary data=].
@@ -1185,8 +1174,7 @@ these steps:
11851174
</div>
11861175

11871176
<div algorithm>
1188-
The <dfn method for=FileSystemSyncAccessHandle>getSize()</dfn> method, when invoked, must run
1189-
these steps:
1177+
The <dfn method for=FileSystemSyncAccessHandle>getSize()</dfn> method steps are:
11901178

11911179
1. If [=this=].[=[[state]]=] is "`closed`", throw an {{InvalidStateError}}.
11921180
1. Return [=this=].[=FileSystemSyncAccessHandle/[[file]]=]'s [=file entry/binary data=]'s [=byte sequence/length=].
@@ -1202,8 +1190,7 @@ these steps:
12021190
</div>
12031191

12041192
<div algorithm>
1205-
The <dfn method for=FileSystemSyncAccessHandle>flush()</dfn> method, when invoked, must run
1206-
these steps:
1193+
The <dfn method for=FileSystemSyncAccessHandle>flush()</dfn> method steps are:
12071194

12081195
// TODO(fivedots): Fill in, after figuring out language to describe flushing at the OS level.
12091196

@@ -1219,10 +1206,8 @@ these steps:
12191206

12201207
//TODO(fivedots): Figure out language to describe flushing the file at the OS level before closing the handle.
12211208
<div algorithm>
1222-
The <dfn method for=FileSystemSyncAccessHandle>close()</dfn> method, when invoked, must run
1223-
these steps:
1224-
1225-
1. Set [=this=].[=[[state]]=] to "`closed`".
1209+
The <dfn method for=FileSystemSyncAccessHandle>close()</dfn> method steps are
1210+
to set [=this=].[=[[state]]=] to "`closed`".
12261211

12271212
</div>
12281213

@@ -1255,8 +1240,7 @@ partial interface StorageManager {
12551240
</div>
12561241

12571242
<div algorithm>
1258-
The <dfn method for=StorageManager>getDirectory()</dfn> method, when
1259-
invoked, must run these steps:
1243+
The <dfn method for=StorageManager>getDirectory()</dfn> method steps are:
12601244

12611245
1. Let |environment| be the [=current settings object=].
12621246

0 commit comments

Comments
 (0)