fin-utils
Shared utilities for Fin.
Install
npm install fin-utils
Usage
parseFaasIdentifier
const finUtils = // parses any FaaS identifier (see the FaaS format below for more examples)const parsedInfo = finUtils if !parsedInfo console else const projectId serviceName deploymentHash version = parsedInfo if serviceName console else console
validators
const finUtils = const validators = finUtils validators // truevalidators // false validators // truevalidators // false validators // truevalidators // false (too short) validators // truevalidators // false validators // truevalidators // false validators // truevalidators // false validators // truevalidators // false
FaaS Identifier Format
The most general FaaS identifier fully specifies the deployment and service name.
It may include an optional URL prefix such as http://localhost:5000/1/call/
in development or https://api.functional-income.com/1/call/
in production. The parsed result will be the same with or without the full URL prefix.
username/projectName.serviceName@01234567 // explicitly identify a specific deployment (may not be published)
username/projectName.serviceName@latest // explicitly identify the latest published deployment
username/projectName.serviceName@1.0.0 // explicitly identify a the published deployment with a specific version
username/projectName.serviceName // implicitly identify the latest published deployment
If no serviceName
is specified, it is assumed that the deployment only has a single service and errors if this is not the case.
username/projectName@01234567
username/projectName@latest
username/projectName@1.0.0
username/projectName
Omitting username
You may optionally leave off the username/
prefix when referring to your own projects and deployments via the dev CLI.
projectName@01234567
projectName@latest
projectName@1.0.0
projectName
An example of this for the hello-world
project would look like:
# view all deployments for the authenticated user's hello-world project fin ls hello-world
This would be equivalent to:
# view all deployments for my-user-name/hello-world project fin ls my-user-name/hello-world
Related
- fin - Fin is the easiest way to launch your own SaaS.
- fts - TypeScript standard for rock solid serverless functions.
License
MIT © Travis Fischer