@types/serverless
- Version 3.12.27
- Published
- 44.3 kB
- No dependencies
- MIT license
Install
npm i @types/serverless
yarn add @types/serverless
pnpm add @types/serverless
Overview
TypeScript definitions for serverless
Index
Classes
Interfaces
Type Aliases
Classes
class Serverless
class Serverless {}
constructor
constructor(config?: {});
property classes
classes: Serverless.Classes;
property cli
cli: { log(message: string, entity?: string, options?: Serverless.LogOptions): null;};
property config
config: Serverless.Config;
property configSchemaHandler
configSchemaHandler: { defineCustomProperties(schema: unknown): void; defineFunctionEvent( provider: string, event: string, schema: Record<string, unknown> ): void; defineFunctionEventProperties( provider: string, existingEvent: string, schema: unknown ): void; defineFunctionProperties(provider: string, schema: unknown): void; defineProvider(provider: string, options?: Record<string, unknown>): void; defineTopLevelProperty( provider: string, schema: Record<string, unknown> ): void;};
property configurationFilename
configurationFilename: string;
property pluginManager
pluginManager: PluginManager;
property providers
providers: {};
property resources
resources: AwsProvider.Resources;
property serverlessDirPath
serverlessDirPath: string;
property service
service: Service;
property serviceDir
serviceDir: string;
property utils
utils: Utils;
property variables
variables: { populateService(): Promise<any> };
property version
version: string;
property yamlParser
yamlParser: YamlParser;
method getProvider
getProvider: (name: string) => AwsProvider;
method getVersion
getVersion: () => string;
method init
init: () => Promise<any>;
method run
run: () => Promise<any>;
method setProvider
setProvider: (name: string, provider: AwsProvider) => null;
Interfaces
interface Config
interface Config {}
property serviceDir
serviceDir: string;
property servicePath
servicePath: string;
interface FunctionDefinition
interface FunctionDefinition {}
property environment
environment?: { [name: string]: string } | undefined;
property events
events: AwsProvider.Event[];
property memorySize
memorySize?: number | undefined;
property name
name?: string | undefined;
property package
package?: Package | undefined;
property reservedConcurrency
reservedConcurrency?: number | undefined;
property runtime
runtime?: string | undefined;
property tags
tags?: { [key: string]: string } | undefined;
property timeout
timeout?: number | undefined;
interface FunctionDefinitionHandler
interface FunctionDefinitionHandler extends FunctionDefinition {}
property handler
handler: string;
interface FunctionDefinitionImage
interface FunctionDefinitionImage extends FunctionDefinition {}
property image
image: string;
interface LogOptions
interface LogOptions {}
interface Options
interface Options {}
CLI options provided to the command
Example 1
// serverless --verbose --stage prod { verbose: true, stage: 'prod' }
property extraServicePath
extraServicePath?: string | undefined;
property function
function?: string | undefined;
property noDeploy
noDeploy?: boolean | undefined;
property region
region?: string | undefined;
property stage
stage?: string | undefined;
property verbose
verbose?: boolean | undefined;
property watch
watch?: boolean | undefined;
index signature
[key: string]: string | boolean | string[] | undefined;
interface Package
interface Package {}
property artifact
artifact?: string | undefined;
property exclude
exclude?: string[] | undefined;
Deprecated
use
patterns
instead
property include
include?: string[] | undefined;
Deprecated
use
patterns
instead
property individually
individually?: boolean | undefined;
property patterns
patterns?: string[] | undefined;
Type Aliases
type Event
type Event = AwsProvider.Event | object;
Package Files (1)
Dependencies (0)
No dependencies.
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/serverless
.
- Markdown[](https://www.jsdocs.io/package/@types/serverless)
- HTML<a href="https://www.jsdocs.io/package/@types/serverless"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 1992 ms. - Missing or incorrect documentation? Open an issue for this package.