Skip to content

Commit 08900f4

Browse files
committed
docs(node8-branch): updated docs to reflect node8 branch fix
re #4
1 parent 68cc275 commit 08900f4

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ glob patterns to only include certain files (`*.func.js`).
109109
You can now also control how the function trigger export is "found" from each module file. For example, instead of using
110110
a default export, you can opt to use a named export called `export const functionTrigger = functions...`.
111111

112-
#### Warnings
112+
### Warnings
113113

114114
Try to avoid collisions, where two modules are exported to the same path.
115115

@@ -123,6 +123,12 @@ stripped away (provided they both have a default export)
123123
If you need both files, then you can optionally change their names to use camelCase or use a dash `-` (which are also
124124
automatically converted to camelCase) leaving only the dot in .js.
125125

126+
#### Node 8
127+
128+
If you are using Firebase Functions in Node v8, then the master branch will not work with default settings. The
129+
funcNameFromRelPath method uses a dependency called `camelCase` which crashes in v8. There is a specific branch for Node
130+
v8 called `node8` that can be installed via `npm install [email protected]:gramstr/better-firebase-functions.git#node8`
131+
126132
## Contribute
127133

128134
Please contribute to this project by submitting a pull request. Use Commitizen to generate correct commit messages.

0 commit comments

Comments
 (0)