Skip to content

Commit e588f2b

Browse files
author
Izaak Gough
committed
docs: add comment documenting 0s minimum timeout behaviour
1 parent 22244c9 commit e588f2b

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

src/v2/options.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,10 @@ export interface GlobalOptions {
192192
* HTTPS functions can specify a higher timeout.
193193
*
194194
* @remarks
195-
* The minimum timeout for a 2nd gen function is 1s. The maximum timeout for a
196-
* function depends on the type of function: Event handling functions have a
195+
* The minimum timeout for a 2nd gen (and 1st gen) function is 0s; this has the precise
196+
* meaning of being 'un-set' and ends up defaulting to 60s.
197+
* The maximum timeout for a function depends on the type of function:
198+
* Event handling functions have a
197199
* maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
198200
* maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
199201
* timeout of 1,800s (30 minutes).

0 commit comments

Comments
 (0)