Skip to main content

Function: rmUserById()

rmUserById(catalogDir): (id) => Promise<void>

Defined in: users.ts:137

Delete a user by it's id.

Parameters

ParameterType
catalogDirstring

Returns

Function

Parameters

ParameterType
idstring

Returns

Promise<void>

Example

import utils from '@eventcatalog/utils';

const { rmUserById } = utils('/path/to/eventcatalog');

// deletes the user with id eventcatalog-core-user
await rmUserById('eventcatalog-core-user');