Skip to content

Latest commit

 

History

History
145 lines (107 loc) · 4.92 KB

README.md

File metadata and controls

145 lines (107 loc) · 4.92 KB
Raw

Request Options

A sophisticated way to pass custom options through interceptors from the HTTP client instnace

Downloads per month Version License

Don't forget to follow the project's author, Ezz, and consider starring the project to show your ❤️ and support.

Installation

npm install @ezzabuzaid/ngx-request-options

Usage

The library was designed to be added without further modification, you'll still use the same HttpClient but with one additional augment the configure method that takes the default options before choosing the HTTP method.

  1. First of all you need to create your custom options object
interface CustomOptions {
    defaultUrl: boolean;
    defaultAuth: boolean;
}
  1. in app.module you need to import RequestOptionsModule and to add it to imports list in NgModule
import { RequestOptionsModule } from  '@ezzabuzaid/ngx-request-options';

@NgModule({
	imports: [
		HttpClientModule,
		RequestOptionsModule.forRoot<CustomOptions>({
			// Default options to be applied on all requests
			defaultAuth: true;
			defaultUrl: true
		})
		]
})

  
// Add those lines as they are
declare module '@angular/common/http/http' {
	// Augment HttpClient with the added `configure` method
	export  interface  HttpClient {
		/**
		* Configure request options.
		*/
		configure(options: Partial<CustomOptions>): HttpClient;
	}
}

Please make sure that the you call the forRoot() .

  1. Inject HttpClient from @angular/common/http in a class then call the new configure method
@Injectable()
export class MyService {
	constructor(private http: HttpClient) { }
	getData() {
		return this.http
			.configure({ defaultUrl:  false })
			.get('endpoint');
	}
}
  1. into an interceptor
import { RequestOptions } from '@ezzabuzaid/ngx-request-options';
@Injectable()
export class UrlInterceptor implements HttpInterceptor {
	constructor(private requestOptions: RequestOptions<CustomOptions>) { }
	intercept(request: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
		let  url = request.url;
		if (this.requestOptions.get(request, 'defaultUrl')) {
			url = environment.endpointUrl + request.url;
		}
		return  next.handle(this.requestOptions.clone(request, { url }));
	}
}

Note about request.clone , Cloning the request will lose the associated options with it, hence you need to tell the RequestOptions that the original request will be garbage collected. The request.clone method will return new request object with new metadata which means that the original request will be lost.

RequestOptions.clone(request: HttpRequest, metadata) to resuce, using the clone method from RequestOptions will do the cloning implicitly and reassign the options again to the new Request object

Api's

  • RequestOptions

    1. get(request: HttpRequest<any>, option: keyof T)
    • Get an option from the options that was assigned to the request
    1. set(request: HttpRequest<any>, data: Partial<T>)
    • Assign an options to a request
    1. delete(request: HttpRequest<any>)
    • Delete the request options
    1. clone(request: HttpRequest<any>, requestMetadata)
    • Clone the request with new metadata and reassign the options to it
    1. changeRequest(oldRequest: HttpRequest<any>, newRequest: HttpRequest<any>)
    • Sometimes you need to call request.clone() to assign new values to request payload aka metadata thus you need to reassign the options again to the cloned request otherwise the options will be lost. call RequestOptions.clone() instead as shorter version
    • oldRequest the previously used request
    • newRequest the cloned request

  • REQUEST_OPTIONS_DEFAULT you can use this injection token to retrieve the global options that have set in forRoot method

Contributing

Don't hesitate to open issues and make a pull request to help improve code

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Versioning

This library will be maintained under the semantic versioning guidelines. Releases will be numbered with the following format: <major>.<minor>.<patch>

For more information on SemVer, please visit http://semver.org.

Developer

Ezzabuzaid

License

The MIT License (MIT)

Built with love <3