add some usage examples

bmoffatt · bmoffatt · commit d1db4443511a · 2022-05-18T16:50:14.000-07:00
diff --git a/lambda/handler.go b/lambda/handler.go
@@ -28,20 +28,44 @@ type handlerOptions struct {
 type Option func(*handlerOptions)
 
 // WithContext is a HandlerOption that sets the base context for all invocations of the handler.
+//
+// Usage:
+//  lambda.StartWithOptions(
+//   	func (ctx context.Context) (string, error) {
+//   		return ctx.Value("foo"), nil
+//   	},
+//   	lambda.WithContext(context.WithValue(context.Background(), "foo", "bar"))
+//  )
 func WithContext(ctx context.Context) Option {
 	return Option(func(h *handlerOptions) {
 		h.baseContext = ctx
 	})
 }
 
 // WithSetEscapeHTML sets the SetEscapeHTML argument on the underlying json encoder
+//
+// Usage:
+//  lambda.StartWithOptions(
+//  	func () (string, error) {
+//  		return "<html><body>hello!></body></html>", nil
+//  	},
+//  	lambda.WithSetEscapeHTML(true),
+//  )
 func WithSetEscapeHTML(escapeHTML bool) Option {
 	return Option(func(h *handlerOptions) {
 		h.jsonResponseEscapeHTML = escapeHTML
 	})
 }
 
 // WithSetIndent sets the SetIndent argument on the underling json encoder
+//
+// Usage:
+//  lambda.StartWithOptions(
+//  	func (event any) (any, error) {
+//  		return event, nil
+//  	},
+//  	lambda.WithSetIndent(">"," "),
+//  )
 func WithSetIndent(prefix, indent string) Option {
 	return Option(func(h *handlerOptions) {
 		h.jsonResponseIndentPrefix = prefix
