jimple 2.0.0-beta.1 | Documentation

jimple

2.0.0-beta.1

Jimple ▸
- Instance members
- #get
- #set
- #has
- #factory
- #protect
- #keys
- #extend
- #register
- #raw

Need help reading this?

Jimple

The Jimple Container class with TypeScript support

new Jimple(values: Partial<InitialServiceMap<TMap, JimpleWithProxy<TMap>>>?)

Parameters

values (Partial<InitialServiceMap<TMap, JimpleWithProxy<TMap>>>?)

Instance Members

▸ get(key)

Return the specified parameter or service with correct typing

get(key: TKey): ServiceType<TMap, TKey>

Parameters

key (TKey)

Returns

ServiceType<TMap, TKey>

▸ set(key, value)

Defines a new parameter or service

set(key: TKey, value: (ServiceType<TMap, TKey> | ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>)): void

Parameters

key (TKey)

value ((ServiceType<TMap, TKey> | ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>))

Returns

void

▸ has(key)

Returns if a service or parameter is defined

has(key: TKey): boolean

Parameters

key (TKey)

Returns

boolean

▸ factory(fn)

Defines a service as a factory

factory(fn: T): T

Parameters

fn (T)

Returns

T

▸ protect(fn)

Defines a function as a parameter

protect(fn: T): T

Parameters

fn (T)

Returns

T

▸ keys()

Return all the keys registered in the container

keys(): Array<any>

Returns

Array<any>

▸ extend(key, fn)

Extends a service already registered in the container

extend(key: TKey, fn: ServiceExtender<TResult, JimpleWithProxy<TMap>>): void

Parameters

key (TKey)

fn (ServiceExtender<TResult, JimpleWithProxy<TMap>>)

Returns

void

▸ register(provider)

Uses a provider to extend the service

Parameters

provider (Provider<JimpleWithProxy<TMap>>)

Returns

void

▸ raw(key)

Returns the raw value of a service or parameter

raw(key: TKey): (ServiceType<TMap, TKey> | ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>)

Parameters

key (TKey)

Returns

(ServiceType<TMap, TKey> | ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>)