1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 06:46:26 +01:00
Files
openshift-docs/serverless/functions/serverless-developing-typescript-functions.adoc
Maxim Svistunov 7dd561f457 Add docs on developing TypeScript functions
Fix section ID

Move TypeScript context object reference to the proper guide

Fix function header

Co-authored-by: Lance Ball <lball@redhat.com>

Fix another function header

Co-authored-by: Lance Ball <lball@redhat.com>

Improve wording

Co-authored-by: Lance Ball <lball@redhat.com>

Fix yet another function header

Co-authored-by: Lance Ball <lball@redhat.com>

Fix broken list

Add the step of installing dependencies

Substitute curl commands with kn func emit commands

Improve kn func emit examples

Several stylistic improvements

Make paragraph more precise

Co-authored-by: jrangelramos <jrangelramos@gmail.com>

Add a comma

Use updated TypeScript code examples

Co-authored-by: Lance Ball <lball@redhat.com>

Improvements to TypeScript code

Improve TypeScript code

Co-authored-by: jrangelramos <jrangelramos@gmail.com>
2021-09-01 16:30:44 +00:00

39 lines
2.4 KiB
Plaintext

include::modules/serverless-document-attributes.adoc[]
[id="serverless-developing-typescript-functions"]
= Developing TypeScript functions
:context: serverless-developing-typescript-functions
include::modules/common-attributes.adoc[]
toc::[]
:FeatureName: {FunctionsProductName}
include::modules/technology-preview.adoc[leveloffset=+2]
After you have xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-create-func-kn_serverless-functions-getting-started[created a TypeScript function project], you can modify the template files provided to add business logic to your function.
[id="prerequisites_serverless-developing-typescript-functions"]
== Prerequisites
* Before you can develop functions, you must complete the steps in xref:../../serverless/functions/serverless-functions-setup.adoc#serverless-functions-setup[Setting up {FunctionsProductName}].
include::modules/serverless-typescript-template.adoc[leveloffset=+1]
[id="serverless-developing-typescript-functions-about-invoking"]
== About invoking TypeScript functions
When using the `kn` CLI to create a function project, you can generate a project that responds to CloudEvents or one that responds to simple HTTP requests. CloudEvents in Knative are transported over HTTP as a POST request, so both function types listen for and respond to incoming HTTP events.
TypeScript functions can be invoked with a simple HTTP request. When an incoming request is received, functions are invoked with a `context` object as the first parameter.
include::modules/serverless-typescript-functions-context-objects.adoc[leveloffset=+2]
include::modules/serverless-typescript-function-return-values.adoc[leveloffset=+1]
include::modules/serverless-testing-typescript-functions.adoc[leveloffset=+1]
[id="next-steps_serverless-developing-typescript-functions"]
== Next steps
* See the xref:../../serverless/functions/serverless-functions-reference-guide.adoc#serverless-typescript-context-object-reference_serverless-functions-reference-guide[TypeScript context object reference] documentation.
* xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-build-func-kn_serverless-functions-getting-started[Build] and xref:../../serverless/functions/serverless-functions-getting-started.adoc#serverless-deploy-func-kn_serverless-functions-getting-started[deploy] a function.
* See link:https://getpino.io/#/docs/api[the Pino API documentation] for more information on logging with functions.