Function: Args()

Call Signature

function Args(): ParameterDecorator;

Defined in: packages/apollo/src/decorators/args.decorator.ts:128

Decorator for resolver arguments.

Returns

ParameterDecorator

Example

@Query()
async user(@Args('id') id: string) { }

@Query()
async users(@Args('limit') limit: number, @Args('offset') offset: number) { }

@Mutation()
async createUser(
  @Args({ name: 'input', type: () => CreateUserInput, description: 'User input' })
  input: CreateUserInput
) { }

@Query()
async search(
  @Args({ name: 'query', nullable: true, defaultValue: '' })
  query: string
) { }

Call Signature

function Args(name): ParameterDecorator;

Defined in: packages/apollo/src/decorators/args.decorator.ts:129

Decorator for resolver arguments.

Parameters

Parameter	Type
name	string

Returns

ParameterDecorator

Example

@Query()
async user(@Args('id') id: string) { }

@Query()
async users(@Args('limit') limit: number, @Args('offset') offset: number) { }

@Mutation()
async createUser(
  @Args({ name: 'input', type: () => CreateUserInput, description: 'User input' })
  input: CreateUserInput
) { }

@Query()
async search(
  @Args({ name: 'query', nullable: true, defaultValue: '' })
  query: string
) { }

Call Signature

function Args(options): ParameterDecorator;

Defined in: packages/apollo/src/decorators/args.decorator.ts:130

Decorator for resolver arguments.

Parameters

Parameter	Type
options	ArgsOptions

Returns

ParameterDecorator

Example

@Query()
async user(@Args('id') id: string) { }

@Query()
async users(@Args('limit') limit: number, @Args('offset') offset: number) { }

@Mutation()
async createUser(
  @Args({ name: 'input', type: () => CreateUserInput, description: 'User input' })
  input: CreateUserInput
) { }

@Query()
async search(
  @Args({ name: 'query', nullable: true, defaultValue: '' })
  query: string
) { }

Call Signature

function Args(name, options): ParameterDecorator;

Defined in: packages/apollo/src/decorators/args.decorator.ts:131

Decorator for resolver arguments.

Parameters

Parameter	Type
name	string
options	Omit<ArgsOptions, "name">

Returns

ParameterDecorator

Example

@Query()
async user(@Args('id') id: string) { }

@Query()
async users(@Args('limit') limit: number, @Args('offset') offset: number) { }

@Mutation()
async createUser(
  @Args({ name: 'input', type: () => CreateUserInput, description: 'User input' })
  input: CreateUserInput
) { }

@Query()
async search(
  @Args({ name: 'query', nullable: true, defaultValue: '' })
  query: string
) { }