fn-serverless/docs/operating/extending.md

Extending IronFunctions

IronFunctions is extensible so you can add custom functionality and extend the project without needing to modify the core.

Listeners

Listeners are the main way to extend IronFunctions.

You can easily use listeners basically creating a struct with [valid methods](#Listener Requirements) and adding it to the IronFunctions API.

Example:

package main

import (
    "context"

    "github.com/iron-io/functions/api/server"
    "github.com/iron-io/functions/api/models"
)

type myCustomListener struct{}

func (c *myCustomListener) BeforeAppCreate(ctx context.Context, app *models.App) error { return nil }
func (c *myCustomListener) AfterAppCreate(ctx context.Context, app *models.App) error { return nil }

func (c *myCustomListener) BeforeAppUpdate(ctx context.Context, app *models.App) error { return nil }
func (c *myCustomListener) AfterAppUpdate(ctx context.Context, app *models.App) error { return nil }

func (c *myCustomListener) BeforeAppDelete(ctx context.Context, appName string) error { return nil }
func (c *myCustomListener) BeforeAppDelete(ctx context.Context, appName string) error { return nil }

function main () {
    srv := server.New(/* Here all required parameters to initialize the server */)

    srv.AddAppCreateListener(myCustomListener)
    srv.AddAppUpdateListener(myCustomListener)
    srv.AddAppDeleteListener(myCustomListener)

    srv.Run()
}

Listener Requirements

To be a valid listener your struct should respect interfaces combined or alone found in the file listeners.go

These are all available listeners:

AppCreateListener

Triggers before and after every app creation that happens in the API

Triggered on requests to the following routes:

• POST /v1/apps
• POST /v1/apps/:app/routes

AppUpdateListener

Triggers before and after every app updates that happens in the API

Triggered during requests to the following routes:

• PUT /v1/apps

AppDeleteListener

Triggers before and after every app deletion that happens in the API

Triggered during requests to the following routes:

• DELETE /v1/apps/app