Skip to content

Commit adcf757

Browse files
committed
update docs
1 parent 29c10b1 commit adcf757

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed

docs/generated/api.json

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1589,6 +1589,71 @@
15891589
"endIndex": 2
15901590
}
15911591
]
1592+
},
1593+
{
1594+
"kind": "Function",
1595+
"canonicalReference": "@google-cloud/functions-framework!run_2:function(1)",
1596+
"docComment": "/**\n * Main entrypoint for the functions framework that loads the user's function and starts the HTTP server.\n *\n * @param code - A function to be executed.\n */\n",
1597+
"excerptTokens": [
1598+
{
1599+
"kind": "Content",
1600+
"text": "main: (code?: "
1601+
},
1602+
{
1603+
"kind": "Reference",
1604+
"text": "HttpFunction",
1605+
"canonicalReference": "@google-cloud/functions-framework!HttpFunction:interface"
1606+
},
1607+
{
1608+
"kind": "Content",
1609+
"text": " | "
1610+
},
1611+
{
1612+
"kind": "Reference",
1613+
"text": "EventFunction",
1614+
"canonicalReference": "@google-cloud/functions-framework!EventFunction:interface"
1615+
},
1616+
{
1617+
"kind": "Content",
1618+
"text": " | "
1619+
},
1620+
{
1621+
"kind": "Reference",
1622+
"text": "CloudEventFunction",
1623+
"canonicalReference": "@google-cloud/functions-framework!CloudEventFunction:interface"
1624+
},
1625+
{
1626+
"kind": "Content",
1627+
"text": ") => "
1628+
},
1629+
{
1630+
"kind": "Reference",
1631+
"text": "Promise",
1632+
"canonicalReference": "!Promise:interface"
1633+
},
1634+
{
1635+
"kind": "Content",
1636+
"text": "<void>"
1637+
}
1638+
],
1639+
"fileUrlPath": "src/main.ts",
1640+
"returnTypeTokenRange": {
1641+
"startIndex": 7,
1642+
"endIndex": 9
1643+
},
1644+
"releaseTag": "Public",
1645+
"overloadIndex": 1,
1646+
"parameters": [
1647+
{
1648+
"parameterName": "code",
1649+
"parameterTypeTokenRange": {
1650+
"startIndex": 1,
1651+
"endIndex": 6
1652+
},
1653+
"isOptional": true
1654+
}
1655+
],
1656+
"name": "run_2"
15921657
}
15931658
]
15941659
}

docs/generated/api.md.api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@ export { Request_2 as Request }
105105

106106
export { Response_2 as Response }
107107

108+
// @public
109+
const run_2: (code?: HttpFunction | EventFunction | CloudEventFunction) => Promise<void>;
110+
export { run_2 as run }
111+
108112
// (No @packageDocumentation comment for this package)
109113

110114
```

0 commit comments

Comments
 (0)