Skip to content

Commit 3bd12fb

Browse files
committed
doc: document event core.fs.create.directory
issue: #1122
1 parent e6b3cb3 commit 3bd12fb

File tree

2 files changed

+42
-2
lines changed

2 files changed

+42
-2
lines changed

doc/contributors/extensions/events.json.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,22 @@ export default [
4747
`
4848
}
4949
},
50+
{
51+
id: 'core.fs.create.directory',
52+
description: `
53+
This event is emitted when a directory is created.
54+
`,
55+
properties: {
56+
node: {
57+
type: 'FSNodeContext',
58+
mutability: 'no-effect',
59+
summary: 'the directory that was created',
60+
},
61+
context: {
62+
type: 'Context',
63+
mutability: 'no-effect',
64+
summary: 'current context'
65+
},
66+
}
67+
},
5068
];

doc/contributors/extensions/events.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,25 @@ The event can be used to block certain emails from being validated.
88
the email being validated
99
- **Type**: string
1010
- **Mutability**: no-effect
11-
- **Notes**: undefined
11+
- **Notes**:
1212
- The email may have already been cleaned.
13+
1314
#### Property `allow`
1415

1516
whether the email is allowed
1617
- **Type**: boolean
1718
- **Mutability**: mutable
18-
- **Notes**: undefined
19+
- **Notes**:
1920
- If set to false, the email will be considered invalid.
2021

22+
2123
### `core.request.measured`
2224

2325
This event is emitted when a requests incoming and outgoing bytes
2426
have been measured.
2527

28+
#### Example
29+
2630
```javascript
2731
extension.on('core.request.measured', data => {
2832
const measurements = data.measurements;
@@ -36,3 +40,21 @@ extension.on('core.request.measured', data => {
3640
});
3741
});
3842
```
43+
44+
### `core.fs.create.directory`
45+
46+
This event is emitted when a directory is created.
47+
48+
#### Property `node`
49+
50+
the directory that was created
51+
- **Type**: FSNodeContext
52+
- **Mutability**: no-effect
53+
54+
#### Property `context`
55+
56+
current context
57+
- **Type**: Context
58+
- **Mutability**: no-effect
59+
60+

0 commit comments

Comments
 (0)