Class default<TMap>

The Jimple Container class with TypeScript support. A dependency injection container that manages services and parameters.

Example

interface MyServices extends ServiceMap {
  logger: Logger;
  userService: UserService;
}

const container = Jimple.create<MyServices>();
container.set('logger', () => new ConsoleLogger());
container.set('userService', (c) => new UserService(c.logger));

const userService = container.userService; // Typed as UserService

Type Parameters

TMap extends ServiceMap = ServiceMap
The service map extending ServiceMap

Jimple

Index

Constructors

constructor

Methods

extend factory get has keys protect raw register set unset create provider

Constructors

constructor

new default<TMap extends ServiceMap = ServiceMap>(
values?: Partial<InitialServiceMap<TMap, JimpleWithProxy<TMap>>>,
): default<TMap>
Create a Jimple Container.
Type Parameters
- TMap extends ServiceMap = ServiceMap
Parameters
- Optionalvalues: Partial<InitialServiceMap<TMap, JimpleWithProxy<TMap>>>
  Initial services and parameters to register
Returns default<TMap>
Example
```
const container = new Jimple<MyServices>({
  config: { apiUrl: 'https://api.example.com' },
  logger: (c) => new Logger(c.config)
});
```
- Defined in Jimple.ts:242

Methods

extend

extend<TKey extends string | number | symbol, TResult>(
key: TKey,
fn: ServiceExtender<TResult, JimpleWithProxy<TMap>>,
): void
Extends a service already registered in the container. Allows decorating or modifying an existing service definition.
Type Parameters
- TKey extends string | number | symbol
  The service key type
- TResult
  The extended service type
Parameters
- key: TKey
  The service key to extend
- fn: ServiceExtender<TResult, JimpleWithProxy<TMap>>
  Function that receives the original service and returns the extended version
Returns void
Throws
When the service is not defined, not a function, protected, or already instantiated
Example
```
container.set('logger', () => new Logger());

container.extend('logger', (logger, c) => {
  return new LoggerDecorator(logger, c.config);
});
```
- Defined in Jimple.ts:517

factory

factory<
    TKey extends string
    | number
    | symbol,
    T extends ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>,
>(
    fn: T,
): T
Defines a service as a factory that creates new instances on every access. Unlike regular services (which are singletons), factories always call the function.
Type Parameters
- TKey extends string | number | symbol
  The service key type
- T extends ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>
  The factory function type
Parameters
- fn: T
  The factory function to mark
Returns T
The same function (for chaining)
Throws
When the value is not a function
Example
```
container.set('requestId', container.factory(() => Math.random().toString()));

const id1 = container.get('requestId'); // Different value each time
const id2 = container.get('requestId'); // Different value each time
```
- Defined in Jimple.ts:452

get

get<TKey extends string | number | symbol>(key: TKey): ServiceType<TMap, TKey>
Return the specified parameter or service with correct typing. Services defined as functions are instantiated when first accessed (singleton pattern). Services marked as factories are instantiated on every access. Services marked as protected are returned as-is without being called.
Type Parameters
- TKey extends string | number | symbol
  The service key type
Parameters
- key: TKey
  The service key to retrieve
Returns ServiceType<TMap, TKey>
The service instance or parameter value
Throws
When the service is not defined
Example
```
const logger = container.get('logger');
const apiUrl = container.get('apiUrl');
```
- Defined in Jimple.ts:334

has

has<TKey extends string | number | symbol>(key: TKey): boolean
Returns if a service or parameter is defined in the container.
Type Parameters
- TKey extends string | number | symbol
  The service key type
Parameters
- key: TKey
  The service key to check
Returns boolean
True if the service is defined
Example
```
if (container.has('logger')) {
  const logger = container.get('logger');
}
```
- Defined in Jimple.ts:430

keys

keys(): (keyof TMap)[]
Return all the keys registered in the container.

Returns (keyof TMap)[]
Array of all service keys
Example
```
const keys = container.keys();
console.log('Registered services:', keys);
```
- Defined in Jimple.ts:494

protect

protect<T extends (...args: any[]) => any>(fn: T): T
Defines a function as a parameter (protected from being called as a service factory). The function will be returned as-is when accessed, not executed.
Type Parameters
- T extends (...args: any[]) => any
  The function type
Parameters
- fn: T
  The function to protect
Returns T
The same function (for chaining)
Throws
When the value is not a function
Example
```
const callback = (data: any) => console.log(data);
container.set('onComplete', container.protect(callback));

const fn = container.get('onComplete'); // Returns the function itself
fn('Hello'); // Can be called later
```
- Defined in Jimple.ts:478

raw

raw<TKey extends string | number | symbol>(
    key: TKey,
):
    | ServiceType<TMap, TKey>
    | ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>
Returns the raw value of a service or parameter without instantiation. For services defined as functions, returns the function itself rather than calling it.
Type Parameters
- TKey extends string | number | symbol
  The service key type
Parameters
- key: TKey
  The service key
Returns
| ServiceType<TMap, TKey>
| ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>
The raw service definition or parameter value
Throws
When the service is not defined
Example
```
const factory = container.raw('logger'); // Returns the factory function
const logger = factory(container); // Manually instantiate
```
- Defined in Jimple.ts:588

register

register<K extends string | number | symbol>(
provider: ServiceProvider<Pick<TMap, K>>,
): void
Uses a provider to extend the service container. Providers are objects with a register method that can add multiple services.
Type Parameters
- K extends string | number | symbol
  The subset of service keys the provider manages
Parameters
- provider: ServiceProvider<Pick<TMap, K>>
  The service provider to register
Returns void
Example
```
const databaseProvider = Jimple.provider<MyServices>((container) => {
  container.set('db', () => new Database(container.config));
  container.set('userRepo', (c) => new UserRepository(c.db));
});

container.register(databaseProvider);
```
- Defined in Jimple.ts:567

set

set<TKey extends string | number | symbol>(
    key: TKey,
    value:
        | ServiceType<TMap, TKey>
        | ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>,
): void
Defines a new parameter or service. Functions are treated as service factories unless marked as protected.
Type Parameters
- TKey extends string | number | symbol
  The service key type
Parameters
- key: TKey
  The service key
- value:
  | ServiceType<TMap, TKey>
  | ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>
  The service value, instance, or factory function
Returns void
Throws
When trying to redefine an already instantiated service
Example
```
// Parameter
container.set('apiUrl', 'https://api.example.com');

// Service factory
container.set('logger', (c) => new Logger(c.apiUrl));

// Service instance
container.set('cache', new MemoryCache());
```
- Defined in Jimple.ts:378

unset

unset<TKey extends string | number | symbol>(key: TKey): void
Unsets a parameter or service, removing it from the container. Also clears any cached instances and metadata for the service.
Type Parameters
- TKey extends string | number | symbol
  The service key type
Parameters
- key: TKey
  The service key to remove
Returns void
Example
```
container.unset('logger');
console.log(container.has('logger')); // false
```
- Defined in Jimple.ts:406

`Static`create

create<TMap extends ServiceMap = ServiceMap>(
values?: Partial<InitialServiceMap<TMap, JimpleWithProxy<TMap>>>,
): JimpleWithProxy<TMap>
Creates a new Jimple container instance with proxy support.
Type Parameters
- TMap extends ServiceMap = ServiceMap
  The service map
Parameters
- Optionalvalues: Partial<InitialServiceMap<TMap, JimpleWithProxy<TMap>>>
  Initial services and parameters to register
Returns JimpleWithProxy<TMap>
A proxy-enhanced container
Example
```
const container = Jimple.create<MyServices>({
  logger: () => new ConsoleLogger(),
  apiUrl: 'https://api.example.com'
});
```
- Defined in Jimple.ts:224

`Static`provider

provider<TMap extends ServiceMap = ServiceMap>(
register: (container: JimpleWithProxy<TMap>) => void,
): ServiceProvider<TMap>
Creates a service provider object.
Type Parameters
- TMap extends ServiceMap = ServiceMap
  The service map
Parameters
- register: (container: JimpleWithProxy<TMap>) => void
  Function that registers services with a container
  - (container: JimpleWithProxy<TMap>): void
    Registers services with the provided container.
    
    Parameters
    container: JimpleWithProxy<TMap>
    The container to register services with
    
    Returns void
Returns ServiceProvider<TMap>
A service provider object
Example
```
const myProvider = Jimple.provider<MyServices>((container) => {
  container.set('logger', () => new Logger());
});
```
- Defined in Jimple.ts:204

Class default<TMap>

Example

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns default<TMap>

Example

Methods

extend

Type Parameters

Parameters

Returns void

Throws

Example

factory

Type Parameters

Parameters

Returns T

Throws

Example

get

Type Parameters

Parameters

Returns ServiceType<TMap, TKey>

Throws

Example

has

Type Parameters

Parameters

Returns boolean

Example

keys

Returns (keyof TMap)[]

Example

protect

Type Parameters

Parameters

Returns T

Throws

Example

raw

Type Parameters

Parameters

Returns | ServiceType<TMap, TKey> | ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>

Throws

Example

register

Type Parameters

Parameters

Returns void

Example

set

Type Parameters

Parameters

Returns void

Throws

Example

unset

Type Parameters

Parameters

Returns void

Example

Staticcreate

Type Parameters

Parameters

Returns JimpleWithProxy<TMap>

Example

Staticprovider

Type Parameters

Parameters

Parameters

Returns void

Returns ServiceProvider<TMap>

Example

Settings

Returns
| ServiceType<TMap, TKey>
| ServiceFactory<ServiceType<TMap, TKey>, JimpleWithProxy<TMap>>

`Static`create

`Static`provider